Skip to content

Commit fc265a5

Browse files
committed
README.md corrections/refinements.
1 parent 3f88b61 commit fc265a5

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222

2323
## Overview
2424

25-
StickyEncoding facilitates the encoding and decoding of `Codable` values into and output of a binary
25+
StickyEncoding facilitates the encoding and decoding of `Codable` values into and out of a binary
2626
format that can be stored on disk or sent over a socket.
2727

28-
Encoding is done using a `BinaryEncoder` instance and will encode any `Encodable` type whether you declare conformance to `Encodable` and let the compiler create the code or you manually implement the conformance yourself.
28+
Encoding is done using a `BinaryEncoder` instance and will encode any `Encodable` type whether you declare conformance to `Encodable` and let the compiler create the code, or you manually implement the conformance yourself.
2929

3030
Decoding is done using a `BinaryDecoder` instance and can decode any `Decodable` type that was previously encoded using the `BinaryEncoder`. Of course you can declare `Encodable` or `Decodable` conformance by using `Codable` as well.
3131

@@ -43,7 +43,7 @@ To create an instance of a BinaryEncoder:
4343

4444
> Note: You may optionally pass your own userInfo `BinaryEncoder(userInfo:)` structure and it will be available to you during the encoding.
4545
46-
You can encode any top even top-level single value types including Int,
46+
You can encode any top-level single value type including Int,
4747
UInt, Double, Bool, and Strings. Simply pass the value to the instance
4848
of the BinaryEncoder and call `encode`.
4949
```Swift
@@ -81,9 +81,9 @@ To decode, you pass the Type of object to create, and an instance of encoded dat
8181

8282
### EncodedData
8383

84-
An intermediate representation which represents the encoded data. This type is the direct connection between raw memory and a type that can be converted to and from a `Codable` object.
84+
The `BinaryEncoder.encode` method returns a type called `EncodedData` (likewise `BinaryDecoder.decode` accepts an `EncodedData` instance). This type is the direct connection between raw memory and a type that can be converted to and from a `Codable` object.
8585

86-
StickyEncoding uses an intermediate representation so that it can support many use cases from direct byte conversion to writing/reading directly to/from raw memory.
86+
StickyEncoding uses this intermediate representation so that it can support many use cases from direct byte conversion to writing/reading directly to/from raw memory.
8787

8888
When encoding of an object, the intermediate representation has already been
8989
encoded down to a form that can be rapidly written to memory.

0 commit comments

Comments
 (0)