diff --git a/saphyr/README.md b/saphyr/README.md index 6a334df..eb747b0 100644 --- a/saphyr/README.md +++ b/saphyr/README.md @@ -7,12 +7,12 @@ The missing YAML 1.2 implementation for Rust. [![license](https://img.shields.io/crates/l/yaml-rust.svg)](https://crates.io/crates/yaml-rust/) [![version](https://img.shields.io/crates/v/yaml-rust.svg)](https://crates.io/crates/yaml-rust/) -`yaml-rust` is a pure Rust YAML 1.2 implementation without -any external dependencies, which enjoys the memory safety -property and other benefits from the Rust language. +`yaml-rust` is a pure Rust YAML 1.2 implementation, +which enjoys the memory safety +property and other benefits from the Rust language. The parser is heavily influenced by `libyaml` and `yaml-cpp`. -This crate works on all Rust supported platforms and +This crate works on all Rust-supported platforms. It also works on Rust 1.0.0 and nightly! See [Document](http://chyh1990.github.io/yaml-rust/doc/yaml_rust/) @@ -28,7 +28,7 @@ Add the following to the Cargo.toml of your project: ```toml [dependencies] -yaml-rust = "*" +yaml-rust = "0.3" ``` or @@ -38,7 +38,7 @@ or git = "https://github.com/chyh1990/yaml-rust.git" ``` -and import using *extern crate*: +and import: ```rust extern crate yaml_rust; @@ -76,7 +76,7 @@ bar: // Chained key/array access is checked and won't panic, // return BadValue if they are not exist. assert!(doc["INVALID_KEY"][100].is_badvalue()); - + // Dump the YAML object let mut out_str = String::new(); { @@ -112,7 +112,7 @@ examples in the specification, except for the following known bugs: * Empty plain scalar in certain contexts However, the widely used library `libyaml` also fails to parse these examples, -so it may not be a huge problem for most users. +so it may not be a huge problem for most users. ## Goals @@ -136,4 +136,3 @@ Fork & PR on Github. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. -