Merge pull request #1 from sublabdev/dev

Initial release

Author: Alex Oakley

Doc/ScaleCoder.md

@@ -0,0 +1,41 @@
+### ScaleCoder Example
+
+Bellow is provided an example of `ScaleCoder`'s creation and usage which decodes and encodes any type, conforming to `Codable`.
+
+## Initialization
+
+You can use the default way of creating it:
+
+```Swift
+let coder = ScaleCoder.defaultCoder()
+```
+The above method uses `DefaultScaleCodecAdapterProvider` under the hood
+which supports all the basic `Codable` types out of a box as well as some
+custom ones, including: `struct`; `Int128`; `Int256`; `Int512`; `UInt128`; `UInt256` etc.
+
+On the other hand, you can create your custom one:
+
+```Swift
+let adapterProvider = ScaleCodecAdapterProvider()
+adapterProvider.setAdapter(adapter:for:)
+let encoder = ScaleEncoder(adapterProvider: adapterProvider)
+let decoder = ScaleDecoder(adapterProvider: adapterProvider)
+let coder = ScaleCoder(encoder: encoder, decoder: decoder)
+```
+Note that in the above-mentioned case you have to manually set an adapter for your `Codable` type.
+The library includes adapters for all the basic `Swift` types as well as for custom ones like:
+`struct`; `Int128`; `Int256`; `Int512`; `UInt128`; `UInt256`; `UInt512`; `BigUInt` etc.
+
+*Note:* For all standard numeric types (`Int`; `Int16`; `UInt32` etc.) `NumericAdapter` class should be used.
+
+## Usage
+
+After creating a coder object, it can be to encode (or decode) types (or to types), conforming to `Codable`.
+
+```Swift
+let initialValue = "Some String"
+let encodedValue = coder.encoder.encode(initialValue)
+let decodedValue = coder.decoder.decode(String.self, from: encodedValue)
+```
+
+Here we try to encode and after that to decode a `String` value. The `decodedValue` will be equal to `initialValue`.

Example/.gitignore

@@ -0,0 +1,5 @@
+### CocoaPods ###
+Pods/
+
+## User settings
+xcuserdata/

Example/Podfile

@@ -1,9 +1,11 @@
 use_frameworks!
 
-platform :ios, '10.0'
+platform :ios, '13.0'
 
 target 'ScaleCodecSwift_Example' do
   pod 'ScaleCodecSwift', :path => '../'
+  pod 'CommonSwift', :git => 'https://github.com/sublabdev/common-swift.git', :branch => 'dev'
+  pod 'BigInt'
 
   target 'ScaleCodecSwift_Tests' do
     inherit! :search_paths

Example/Podfile.lock

@@ -1,16 +1,37 @@
 PODS:
-  - ScaleCodecSwift (0.1.0)
+  - BigInt (5.0.0)
+  - CommonSwift (1.0.0):
+    - BigInt (~> 5.0.0)
+  - ScaleCodecSwift (1.0.0):
+    - BigInt (~> 5.0.0)
+    - CommonSwift
 
 DEPENDENCIES:
+  - BigInt
+  - CommonSwift (from `https://github.com/sublabdev/common-swift.git`, branch `dev`)
   - ScaleCodecSwift (from `../`)
 
+SPEC REPOS:
+  trunk:
+    - BigInt
+
 EXTERNAL SOURCES:
+  CommonSwift:
+    :branch: dev
+    :git: https://github.com/sublabdev/common-swift.git
   ScaleCodecSwift:
     :path: "../"
 
+CHECKOUT OPTIONS:
+  CommonSwift:
+    :commit: 24cc1514dedb0755a86ae8b6752778a4ff54fb95
+    :git: https://github.com/sublabdev/common-swift.git
+
 SPEC CHECKSUMS:
-  ScaleCodecSwift: 179b6ddc31bb8528d380fd19166a2a9fddc03e86
+  BigInt: 74b4d88367b0e819d9f77393549226d36faeb0d8
+  CommonSwift: ad350f0e06c040e5cb660cd7154f947851c73fbd
+  ScaleCodecSwift: 2fa35cbc70c5634fdc0960cc6c712e917b2c688c
 
-PODFILE CHECKSUM: eef510782536c545ce866fb495ea308eae3f0286
+PODFILE CHECKSUM: 1a95faa77d7a036005bcfe079d3f5c22b423b9c7
 
 COCOAPODS: 1.11.3