Skip to content

Commit 3cb2192

Browse files
committed
readme update
1 parent 1ece63b commit 3cb2192

File tree

3 files changed

+15
-3
lines changed

3 files changed

+15
-3
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "ion-binary-rs"
3-
version = "0.8.6"
3+
version = "0.8.7"
44
authors = ["Couragium Solutions <[email protected]>"]
55
edition = "2018"
66
description="Pure Rust parser, encoder and hasher for Amazon's Ion binary format."

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,15 @@ Ion binary is a library written in safe rust for parsing, encoding and hashing A
88
[![Documentation](https://docs.rs/ion-binary-rs/badge.svg)](https://docs.rs/ion-binary-rs)
99
[![Crates.io](https://img.shields.io/crates/v/ion-binary-rs)](https://crates.io/crates/ion-binary-rs)
1010

11-
It should be able to **parse**, **encode** and **hash** anything you throw at it. Any failure to do so
11+
It **parses**, **encodes** and **hashes** anything you throw at it. Any failure to do so
1212
is a bug that we will fix and we will be very happy if you report them.
1313

14+
The code is mature and way more tested than Amazon's alternatives, including their js
15+
library. Amazon, when implementing the "good tests" only check that it parses. We check
16+
that the value is the correct one too. Additionally, we seem to be implementing way
17+
more of the ion protocol than Amazon's libraries, as we don't have huge skip lists in
18+
the tests files. We test all their test suite, not only a few test.
19+
1420
## How to use the library
1521

1622
First of all, you need to be aware of the trade offs that we took for this library:

src/lib.rs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,14 @@
77
//! [![Documentation](https://docs.rs/ion-binary-rs/badge.svg)](https://docs.rs/ion-binary-rs)
88
//! [![Crates.io](https://img.shields.io/crates/v/ion-binary-rs)](https://crates.io/crates/ion-binary-rs)
99
//!
10-
//! It should be able to **parse**, **encode** and **hash** anything you throw at it. Any failure to do so
10+
//! It **parses**, **encodes** and **hashes** anything you throw at it. Any failure to do so
1111
//! is a bug that we will fix and we will be very happy if you report them.
12+
//!
13+
//! The code is mature and way more tested than Amazon's alternatives, including their js
14+
//! library. Amazon, when implementing the "good tests" only check that it parses. We check
15+
//! that the value is the correct one too. Additionally, we seem to be implementing way
16+
//! more of the ion protocol than Amazon's libraries, as we don't have huge skip lists in
17+
//! the tests files. We test all their test suite, not only a few test.
1218
//!
1319
//! ## How to use the library
1420
//!

0 commit comments

Comments
 (0)