Skip to content

Commit e3f9a99

Browse files
authored
docs: Minor README updates
1 parent e2150f2 commit e3f9a99

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,23 @@ This module establishes the serialization standard adopted by the Seam API.
2626

2727
### Why not use [URLSearchParams](https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams)?
2828

29-
Passing a raw object to URLSearchParams has unpredictable serialization behavior.
29+
- Passing a raw object to URLSearchParams has unpredictable serialization behavior.
3030

3131
### Why not [qs](https://github.com/ljharb/qs)?
3232

3333
- Not a zero-dependency module. Has quite a few dependency layers.
3434
- Impractile as a reference implementation.
35-
Since qs enables complex, non-standard parsing and serialization,
36-
this makes ensuing SDK parity much harder.
37-
Similarly, this puts an unreasonable burden on User's of the HTTP API or those implementing their own client.
35+
qs enables complex, non-standard parsing and serialization,
36+
which makes ensuing SDK parity much harder.
37+
Similarly, this puts an unreasonable burden on user's of the HTTP API or those implementing their own client.
3838
- The Seam API must ensure it handles a well defined set of non-string query parameters consistency.
3939
Using qs would allow the SDK to send unsupported or incorrectly serialized parameter types to the API
4040
resulting in unexpected behavior.
4141

4242
### Why not use the default [Axios](https://axios-http.com/) serializer?
4343

44-
Using the default [Axios] serializer was the original approach,
45-
however it had similar issues to using URLSearchParams and qs as noted above.
44+
- Using the default [Axios] serializer was the original approach,
45+
however it had similar issues to using URLSearchParams and qs as noted above.
4646

4747
## Installation
4848

0 commit comments

Comments
 (0)