From 5ea5bd50a29259c1f74a7cf93de66724d6fe4b35 Mon Sep 17 00:00:00 2001 From: Alex Touchet Date: Thu, 4 Apr 2024 11:45:20 -0700 Subject: [PATCH] Update xml5ever Readme (#534) --- xml5ever/README.md | 18 +++--------------- 1 file changed, 3 insertions(+), 15 deletions(-) diff --git a/xml5ever/README.md b/xml5ever/README.md index 6c30c02d..ee9a13ad 100644 --- a/xml5ever/README.md +++ b/xml5ever/README.md @@ -23,7 +23,7 @@ templates. XML5 tries to handle most common errors, in a manner similar to HTML5 - You aren't interested in well-formed documents. - You need to get some info from your data even if it has errors (although not all possible errors are handled). - - You want to features like character references or xml namespaces. + - You want to features like character references or XML namespaces. ## When you shouldn't use it @@ -34,17 +34,11 @@ templates. XML5 tries to handle most common errors, in a manner similar to HTML5 # Installation -Add xml5ever as a dependency in your project manifest. +Add xml5ever as a dependency in your project manifest: ```toml [dependencies] - xml5ever = "0.1.3" -``` - -And add crate declaration in your lib.rs - -```rust - extern crate xml5ever + xml5ever = "0.18" ``` # Getting started @@ -77,9 +71,3 @@ To build examples and tests you need to do something along the lines of: This will fetch tests from outside repository and it will invoke cargo to build and test the crate. If you need docs checkout either [API docs](https://docs.rs/xml5ever) or run `cargo docs` to generate documentation. - -## Easy first tasks - -What I generally recommend is to look at Clippy Linting badge results and create -a PR for fixing the said lints. Other than that try to look for any tasks labeled -easy or just update docs/examples.