Skip to content

Commit 8bb0b9b

Browse files
Copilotstreamich
andcommitted
Remove docs/ folder and move codec documentation to src/<codec>/README.md per feedback
Co-authored-by: streamich <[email protected]>
1 parent b4269a7 commit 8bb0b9b

File tree

18 files changed

+241
-2340
lines changed

18 files changed

+241
-2340
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ High performance JSON serialization and deserialization library for JavaScript,
88

99
This library implements the following serialization formats:
1010

11-
- **[MessagePack](./docs/msgpack.md)** - Fast and lean implementation of MessagePack codec
12-
- **[CBOR](./docs/cbor.md)** - Concise Binary Object Representation codec
13-
- **[UBJSON](./docs/ubjson.md)** - Universal Binary JSON codec
14-
- **[JSON](./docs/json.md)** - Enhanced JSON encoder/decoder with additional features
15-
- **[JSON Binary](./docs/json-binary.md)** - JSON with binary data support using Uint8Array
16-
- **[Amazon Ion](./docs/ion.md)** - Amazon's Ion data serialization format
17-
- **[BSON](./docs/bson.md)** - Binary JSON format used by MongoDB
18-
- **[RESP](./docs/resp.md)** - Redis Serialization Protocol (v2 and v3)
19-
- **[Bencode](./docs/bencode.md)** - BitTorrent's encoding format
11+
- **[MessagePack](./src/msgpack/README.md)** - Fast and lean implementation of MessagePack codec
12+
- **[CBOR](./src/cbor/README.md)** - Concise Binary Object Representation codec
13+
- **[UBJSON](./src/ubjson/README.md)** - Universal Binary JSON codec
14+
- **[JSON](./src/json/README.md)** - Enhanced JSON encoder/decoder with additional features
15+
- **[JSON Binary](./src/json-binary/README.md)** - JSON with binary data support using Uint8Array
16+
- **[Amazon Ion](./src/ion/README.md)** - Amazon's Ion data serialization format
17+
- **[BSON](./src/bson/README.md)** - Binary JSON format used by MongoDB
18+
- **[RESP](./src/resp/README.md)** - Redis Serialization Protocol (v2 and v3)
19+
- **[Bencode](./src/bencode/README.md)** - BitTorrent's encoding format
2020

2121
Each format comes with optimized encoders and decoders designed for maximum performance.
2222

@@ -43,14 +43,15 @@ console.log(restored); // {hello: 'world', numbers: [1, 2, 3]}
4343

4444
## Documentation
4545

46-
For detailed documentation on each codec, see the [docs/](./docs/) folder:
46+
For detailed documentation on each codec, refer to the individual README files in their respective folders:
4747

48-
- [Complete documentation index](./docs/README.md)
49-
- Individual codec documentation linked above in the "Supported Formats" section
48+
- Individual codec documentation is available in each `src/<codec>/README.md` file
49+
- Each codec includes comprehensive usage examples, API documentation, and performance benchmarks
5050

5151
## Benchmarks
5252

53-
For comprehensive performance benchmarks comparing `json-pack` with other serialization libraries, see:
53+
The `json-pack` library consistently demonstrates superior performance across various data types and sizes. For comprehensive performance benchmarks and detailed analysis, see:
5454

55-
- [📊 Complete Benchmark Results](./docs/benchmarks.md) - Detailed encoding, decoding, and performance comparisons
5655
- [🚀 Benchmarking JSON Serialization Codecs](https://jsonjoy.com/blog/json-codec-benchmarks) - Analysis showing that `json-pack` is the fastest serialization library in the NPM ecosystem
56+
57+
Each codec also includes specific benchmark results in their individual documentation files.

docs/README.md

Lines changed: 0 additions & 115 deletions
This file was deleted.

0 commit comments

Comments
 (0)