Skip to content

Commit 9ab4323

Browse files
committed
Improved readability of README
1 parent f4c393c commit 9ab4323

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

README.md

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -295,7 +295,7 @@ const type = new sb.StructType({
295295
one: someType,
296296
two: someType
297297
})
298-
/*type translates into
298+
//type translates into
299299
[
300300
0x51 /*StructType*/,
301301
2 /*2 fields*/,
@@ -307,7 +307,6 @@ const type = new sb.StructType({
307307
0xff, /*type is defined previously*/
308308
0, 11 /*type is defined 11 bytes before the 0 on this line*/
309309
]
310-
*/
311310
````
312311
In the following definitions, `type` means the binary type format.
313312

@@ -432,13 +431,13 @@ In the following definitions, `type` means the binary type format.
432431
- `value` - value serialized by specified type
433432
- `RecursiveType`:
434433
- `valueNotYetWrittenInBuffer` - byte containing either `0x00` or `0xFF`
435-
- If `valueNotYetWrittenInBuffer`
434+
- If `valueNotYetWrittenInBuffer`:
436435
- `value` - value serialized by `recursiveType`
437-
- Else
436+
- Else:
438437
- `offset` ([position of first byte of `offset` in buffer] - [position of `value` in buffer]) - `uint32_t`
439438
- `OptionalType`:
440439
- `valueIsNonNull` - byte containing either `0x00` or `0xFF`
441-
- If `valueIsNonNull`
440+
- If `valueIsNonNull`:
442441
- `value` - value serialized by `typeIfNonNull`
443442
- `PointerType`:
444443
- `index` of value in buffer (note: if buffer contains both a type and a value, this index is relative to the start of the value data) - `uint32_t`
@@ -450,7 +449,7 @@ Versions will be of the form `x.y.z`.
450449
`z` is the version of the type and value specification, which is independent of the API version. It should match the version set in `config.js`.
451450

452451
## Testing
453-
To test the NodeJS code, run `npm test`.
452+
To test the Node.js code, run `npm test`.
454453
To test the HTTP transaction code, run `node client-test/server.js` and open `localhost:8080` in your browser. Open each link in a new page. `Upload` and `Download` should each alert `Success`, while `Upload & Download` should alert `Upload: Success` and `Download: Success`.
455454

456455
_Caleb Sander, 2016_

0 commit comments

Comments
 (0)