Skip to content

Commit d4ae83e

Browse files
authored
adapted key feature section to initial list of design principles
1 parent 4da0167 commit d4ae83e

File tree

2 files changed

+19
-16
lines changed

2 files changed

+19
-16
lines changed

README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,15 @@
2323
As the aforementioned libraries are among the most widely used in the respective languages, reflect-cpp fills an important gap in C++ development. It reduces boilerplate code and increases code safety.
2424

2525

26-
### Key Features of reflect-cpp:
26+
### Design principles for reflect-cpp include:
2727

28-
- [**Standard Library Integration:**](https://github.com/getml/reflect-cpp?tab=readme-ov-file#support-for-containers) Works seamlessly with C++ standard containers.
29-
- [**C++ Idiomatic:**](https://rfl.getml.com) Adheres closely to C++ idioms for an intuitive experience.
30-
- [**Built-in JSON Support:**](https://rfl.getml.com/supported_formats/json) Ready-to-use JSON serialization and deserialization.
31-
- [**Simple Installation:**](https://rfl.getml.com/install) Quick setup with minimal configuration.
32-
- [**Easily Extensible:**](https://rfl.getml.com/concepts/structs) Supports [custom serialization formats](https://rfl.getml.com/supported_formats/supporting_your_own_format) and [custom classes](https://rfl.getml.com/concepts/custom_classes).
33-
- [**Benchmarks:**](https://rfl.getml.com/benchmarks) Up to 10x faster than other libraries, such as RapidJSON and nlohmann/json.
28+
- Close integration with [containers](https://github.com/getml/reflect-cpp?tab=readme-ov-file#support-for-containers) from the C++ standard library
29+
- Close adherence to C++ idioms
30+
- Out-of-the-box support for [JSON](https://rfl.getml.com/supported_formats/json)
31+
- Simple [installation](https://rfl.getml.com/install)
32+
- Simple extendability to [other serialization formats](https://rfl.getml.com/supported_formats/supporting_your_own_format)
33+
- Simple extendability to [custom classes](https://rfl.getml.com/concepts/custom_classes)
34+
- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://getml.com/benchmarks)
3435

3536
<br>
3637

@@ -39,7 +40,7 @@ As the aforementioned libraries are among the most widely used in the respective
3940

4041
### On this page
4142
- [Serialization formats](#serialization-formats)
42-
- [Feature Overview]()
43+
- [Feature Overview](#feature-overview)
4344
- [Simple Example](#simple-example)
4445
- [More Comprehensive Example](#more-comprehensive-example)
4546
- [Error messages](#error-messages)

docs/index.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,16 @@ hide:
3333

3434
reflect-cpp fills an important gap in C++ development. It minimizes boilerplate code and enhances code safety for seamless and efficient data exchange across system components.
3535

36-
<h3> Key Features of reflect-cpp:</h3>
37-
38-
- [**Standard Library Integration:**](https://github.com/getml/reflect-cpp?tab=readme-ov-file#support-for-containers) Works seamlessly with C++ standard containers.
39-
- [**C++ Idiomatic:**](https://rfl.getml.com) Adheres closely to C++ idioms for an intuitive experience.
40-
- [**Built-in JSON Support:**](supported_formats/json.md) Ready-to-use JSON serialization and deserialization.
41-
- [**Simple Installation:**](install.md) Quick setup with minimal configuration.
42-
- [**Easily Extensible:**](concepts/structs.md) Supports [custom serialization formats](supported_formats/supporting_your_own_format.md) and [custom classes](concepts/custom_classes.md).
43-
- [**Benchmarks:**](benchmarks.md) Up to 10x faster than other libraries, such as RapidJSON and nlohmann/json.
36+
<h3>Design principles for reflect-cpp include:</h3>
37+
38+
- Close integration with [containers](https://github.com/getml/reflect-cpp?tab=readme-ov-file#support-for-containers) from the C++ standard library
39+
- Close adherence to C++ idioms
40+
- Out-of-the-box support for [JSON](https://rfl.getml.com/supported_formats/json)
41+
- Simple [installation](https://rfl.getml.com/install)
42+
- Simple extendability to [other serialization formats](https://rfl.getml.com/supported_formats/supporting_your_own_format)
43+
- Simple extendability to [custom classes](https://rfl.getml.com/concepts/custom_classes)
44+
- Being one of the fastest serialization libraries in existence, as demonstrated by our [benchmarks](https://getml.com/benchmarks)
45+
4446

4547
## reflect-cpp in a nutshell
4648

0 commit comments

Comments
 (0)