diff --git a/CHANGELOG.md b/CHANGELOG.md index c8e0e2656..be5160e99 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## Unreleased ## [0.8.0] - 2022-08-17 + +- Bump dependencies: `bitflags` to 1.3, `indexmap` to 1.9 ([#399](https://github.com/ron-rs/ron/pull/399)) - Add `integer128` feature that guards `i128` and `u128` ([#304](https://github.com/ron-rs/ron/pull/304), [#351](https://github.com/ron-rs/ron/pull/351)) - Fix issue [#265](https://github.com/ron-rs/ron/issues/265) with better missing comma error ([#353](https://github.com/ron-rs/ron/pull/353)) - Fix issue [#301](https://github.com/ron-rs/ron/issues/301) with better error messages ([#354](https://github.com/ron-rs/ron/pull/354)) diff --git a/Cargo.toml b/Cargo.toml index 63876f77d..7e353ce74 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,12 +2,13 @@ name = "ron" # Memo: update version in src/lib.rs too (doc link) version = "0.8.0" -license = "MIT/Apache-2.0" +license = "MIT OR Apache-2.0" keywords = ["parser", "serde", "serialization"] authors = [ "Christopher Durham ", "Dzmitry Malyshau ", "Thomas Schaller ", + "Juniper Langenstein ", ] edition = "2021" description = "Rusty Object Notation" @@ -16,6 +17,7 @@ readme = "README.md" homepage = "https://github.com/ron-rs/ron" repository = "https://github.com/ron-rs/ron" documentation = "https://docs.rs/ron/" +rust-version = "1.56.0" [features] default = [] @@ -23,8 +25,8 @@ integer128 = [] [dependencies] base64 = "0.13" -bitflags = "1.0.4" -indexmap = { version = "1.0.2", features = ["serde-1"], optional = true } +bitflags = "1.3.2" +indexmap = { version = "1.9.1", features = ["serde-1"], optional = true } serde = { version = "1.0.60", features = ["serde_derive"] } [dev-dependencies] diff --git a/README.md b/README.md index 36036bc21..6ed590823 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ structs, enums, tuples, arrays, generic maps, and primitive values. ## Example -```rust +```rust,ignore GameConfig( // optional struct name window_size: (800, 600), window_title: "PAC-MAN", @@ -71,7 +71,7 @@ GameConfig( // optional struct name ### Same example in RON -```rust +```rust,ignore Scene( // class name is optional materials: { // this is a map "metal": ( diff --git a/src/lib.rs b/src/lib.rs index 418f9faf3..af7b06bcc 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,62 +1,4 @@ -/*! -RON is a simple config format which looks similar to Rust syntax. - -## Features - -* Data types - * Structs, typename optional - * Tuples - * Enums - * Lists - * Maps - * Units (`()`) - * Optionals - * Primitives: booleans, numbers, string, char -* Allows nested layout (similar to JSON) -* Supports comments -* Trailing commas -* Pretty serialization - -## Syntax example - -```rust,ignore -Game( - title: "Hello, RON!", - level: Level( // We could just leave the `Level` out - buildings: [ - ( - size: (10, 20), - color: Yellow, // This as an enum variant - owner: None, - ), - ( - size: (20, 25), - color: Custom(0.1, 0.8, 1.0), - owner: Some("guy"), - ), - ], - characters: { - "guy": ( - friendly: true, - ), - }, - ), -) -``` - -## Usage - -Just add it to your `Cargo.toml`: - -```toml -[dependencies] -ron = "*" -``` - -Serializing / Deserializing is as simple as calling `to_string` / `from_str`. - -!*/ - +#![doc = include_str!("../README.md")] #![doc(html_root_url = "https://docs.rs/ron/0.8.0")] pub mod de;