Skip to content

Commit e28d049

Browse files
authored
docs: Updates main and book README.md files. (#131)
* docs: Updates main and book README.md files. * Fixed spelling errors.
1 parent 3d0161b commit e28d049

File tree

2 files changed

+16
-2
lines changed

2 files changed

+16
-2
lines changed

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,15 @@
88
[docs.rs]: https://docs.rs/xmlity/latest/xmlity/
99
[xmlity msrv]: https://img.shields.io/badge/rustc-1.82.0+-ab6000.svg
1010
[Rust 1.82]: https://blog.rust-lang.org/2023/06/01/Rust-1.82.0.html
11+
[examples]: ./xmlity-quick-xml/examples/
1112

12-
XMLity is a (de)serialization library for XML, inspired by [Serde](https://serde.rs/) and improves upon XML (de)serialization libraries such as [yaserde](https://github.com/media-io/yaserde) and [quick-xml](https://github.com/tafia/quick-xml) by providing a more flexible API that is more powerful, utilising primairly a trial and error approach to parsing XML. This can inherently be a bit slower than other libraries, but it allows for more complex XML structures to be parsed.
13+
XMLity is a (de)serialization library for XML, inspired by [Serde](https://serde.rs/) and improves upon XML (de)serialization libraries such as [yaserde](https://github.com/media-io/yaserde) and [quick-xml](https://github.com/tafia/quick-xml) by providing a more flexible API that is more powerful, utilising primarily a trial and error approach to parsing XML. This can inherently be a bit slower than other libraries, but it allows for more complex XML structures to be parsed.
1314

1415
---
1516

1617
## Get started
1718

18-
To get started, we recommend you check out the [XMLity book](https://xmlity.lukasfri.com) and [the documentation][docs.rs].
19+
To get started, we recommend you check out [the documentation][docs.rs] and [the examples][examples].
1920

2021
## Example
2122

@@ -64,6 +65,16 @@ assert_eq!(person.name.0, "John");
6465
assert_eq!(person.age.0, 42);
6566
```
6667

68+
## Why use XMLity instead of other XML libraries?
69+
70+
- `serde-xml-rs`: Lacking proper namespace support and other features.
71+
- `yaserde`: Lacking support for trial-and-error deserialization, a requirement for full coverage of XML schemas.
72+
- `quick-xml`(`serde` feature): Lacking support for namespaces.
73+
74+
## Other resources
75+
76+
- **The official XML schema generator**: Coming soon! It's already very feature-rich and is good enough to bootstrap itself by deserializing XML schemas using its own generated code, however it still requires some cleanup before its ready for public use.
77+
6778
## License
6879

6980
<sup>

xmlity-book/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# The XMLity Book
2+
3+
This book is not finished and not up to date. Do not use it, refer to the documentation at [docs.rs](https://docs.rs/xmlity/latest/xmlity/) instead.

0 commit comments

Comments
 (0)