From 43af123801bacd8bd3c0971059dab596fa78bcdb Mon Sep 17 00:00:00 2001 From: Dmitriy Pleshevskiy Date: Wed, 27 Jul 2022 10:43:47 +0300 Subject: [PATCH] doc: improve readme --- README.md | 33 +++++++++++---------------------- 1 file changed, 11 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 59d08c2..5a4bda3 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,14 @@ # EString -[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pleshevskiy/estring/CI?label=tests&logo=github&style=flat-square)](https://github.com/pleshevskiy/estring/actions/workflows/ci.yml) -[![docs.rs](https://img.shields.io/docsrs/estring?style=flat-square)](https://docs.rs/estring) [![Crates.io](https://img.shields.io/crates/v/estring?style=flat-square)](https://crates.io/crates/estring) -[![Crates.io](https://img.shields.io/crates/l/estring?style=flat-square)](https://github.com/pleshevskiy/estring/LICENSE) -[![unsafe forbidden](https://img.shields.io/badge/unsafe-forbidden-success.svg?style=flat-square)](https://github.com/rust-secure-code/safety-dance/) -[![Matrix](https://img.shields.io/matrix/enve_team:matrix.org?label=matrix&style=flat-square)](https://matrix.to/#/!yZalHbWfGRWOMaetSn:matrix.org?via=matrix.org) +[![docs.rs](https://img.shields.io/docsrs/estring?style=flat-square)](https://docs.rs/estring) +[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/pleshevskiy/estring/CI?label=tests&logo=github&style=flat-square)](https://github.com/pleshevskiy/estring/actions/workflows/ci.yml) +![The MSRV](https://img.shields.io/badge/MSRV-1.59.0-red.svg) + +```toml +[dependencies] +estring = "0.1" +``` A simple way to parse a string using type annotations. @@ -36,25 +39,11 @@ fn main() -> estring::Result<()> { You can use custom types as annotations! Just implement `estring::ParseFragment`! -## Installation +## Contact Us -**The MSRV is 1.59.0** +Join us in: -Add `estring = { version = "0.1", features = ["structs"] }` as a dependency in -`Cargo.toml`. - -`Cargo.toml` example: - -```toml -[package] -name = "my-crate" -version = "0.1.0" -edition = "2021" -authors = ["Me "] - -[dependencies] -estring = { version = "0.1", features = ["structs"] } -``` +[![Matrix](https://img.shields.io/badge/matrix-%23enve_team:matrix.org-blueviolet.svg?style=flat-square)](https://matrix.to/#/#enve_team:matrix.org) ## License