Skip to content

Commit d4134f6

Browse files
author
Aleph Retamal
committed
Add README.md and update min ios version
1 parent 429926f commit d4134f6

File tree

2 files changed

+38
-0
lines changed

2 files changed

+38
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# RLPSwift
2+
3+
This is a basic Swift implementation of Recursive Length Prefix Encoding, a serialisation method for encoding arbitrarily structured binary data (byte arrays).
4+
5+
You can read more about it here:
6+
* [Ethereum Wiki - RLP](https://github.com/ethereum/wiki/wiki/RLP)
7+
* [Ethereum Yellowpaper](https://ethereum.github.io/yellowpaper/paper.pdf) (Appendix B)
8+
9+
# Getting Started
10+
11+
At the moment is possible to encode Strings and nested arrays of String
12+
13+
```swift
14+
// Encoding strings
15+
RLP.encode("dog") // \u{83}dog
16+
17+
// Encoding arrays is just as easy
18+
RLP.encode(["cat", "dog"]) // \u{c8}\u{83}cat\u{83}dog
19+
```
20+
21+
# Installation
22+
23+
### Manually
24+
This library is small, so you can easily install it manually by dragging and dropping RLP.swift inside your project
25+
26+
# License
27+
28+
RLPSwift is released under an [MIT](https://tldrlegal.com/license/mit-license) license. See [LICENSE](LICENSE) for more information.

RLPSwift.xcodeproj/project.pbxproj

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
objects = {
88

99
/* Begin PBXBuildFile section */
10+
2771CB8C2021F12E003A1E13 /* LICENSE in Resources */ = {isa = PBXBuildFile; fileRef = 2771CB8A2021F12D003A1E13 /* LICENSE */; };
11+
2771CB8D2021F12E003A1E13 /* README.md in Resources */ = {isa = PBXBuildFile; fileRef = 2771CB8B2021F12D003A1E13 /* README.md */; };
1012
27756E062021D8FF004B2339 /* RLPSwift.h in Headers */ = {isa = PBXBuildFile; fileRef = 27756E042021D8FF004B2339 /* RLPSwift.h */; settings = {ATTRIBUTES = (Public, ); }; };
1113
27756E172021D9CE004B2339 /* RLPTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 27756E162021D9CE004B2339 /* RLPTests.swift */; };
1214
27756E192021D9CE004B2339 /* RLPSwift.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 27756E012021D8FF004B2339 /* RLPSwift.framework */; };
@@ -24,6 +26,8 @@
2426
/* End PBXContainerItemProxy section */
2527

2628
/* Begin PBXFileReference section */
29+
2771CB8A2021F12D003A1E13 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE; sourceTree = "<group>"; };
30+
2771CB8B2021F12D003A1E13 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = "<group>"; };
2731
27756E012021D8FF004B2339 /* RLPSwift.framework */ = {isa = PBXFileReference; explicitFileType = wrapper.framework; includeInIndex = 0; path = RLPSwift.framework; sourceTree = BUILT_PRODUCTS_DIR; };
2832
27756E042021D8FF004B2339 /* RLPSwift.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = RLPSwift.h; sourceTree = "<group>"; };
2933
27756E052021D8FF004B2339 /* Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
@@ -55,6 +59,8 @@
5559
27756DF72021D8FF004B2339 = {
5660
isa = PBXGroup;
5761
children = (
62+
2771CB8A2021F12D003A1E13 /* LICENSE */,
63+
2771CB8B2021F12D003A1E13 /* README.md */,
5864
27756E0C2021D966004B2339 /* Source */,
5965
27756E152021D9CE004B2339 /* Tests */,
6066
27756E022021D8FF004B2339 /* Products */,
@@ -199,6 +205,8 @@
199205
isa = PBXResourcesBuildPhase;
200206
buildActionMask = 2147483647;
201207
files = (
208+
2771CB8D2021F12E003A1E13 /* README.md in Resources */,
209+
2771CB8C2021F12E003A1E13 /* LICENSE in Resources */,
202210
);
203211
runOnlyForDeploymentPostprocessing = 0;
204212
};
@@ -364,6 +372,7 @@
364372
DYLIB_INSTALL_NAME_BASE = "@rpath";
365373
INFOPLIST_FILE = "$(SRCROOT)/Source/Info.plist";
366374
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
375+
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
367376
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
368377
PRODUCT_BUNDLE_IDENTIFIER = io.lalacode.RLPSwift;
369378
PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";
@@ -386,6 +395,7 @@
386395
DYLIB_INSTALL_NAME_BASE = "@rpath";
387396
INFOPLIST_FILE = "$(SRCROOT)/Source/Info.plist";
388397
INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
398+
IPHONEOS_DEPLOYMENT_TARGET = 9.0;
389399
LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
390400
PRODUCT_BUNDLE_IDENTIFIER = io.lalacode.RLPSwift;
391401
PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)";

0 commit comments

Comments
 (0)