aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..507df4e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,27 @@
+# winnow, making parsing a breeze
+
+[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Build Status](https://github.com/winnow-rs/winnow/actions/workflows/ci.yml/badge.svg)](https://github.com/winnow-rs/winnow/actions/workflows/ci.yml)
+[![Coverage Status](https://coveralls.io/repos/github/winnow-rs/winnow/badge.svg?branch=main)](https://coveralls.io/github/winnow-rs/winnow?branch=main)
+[![Crates.io Version](https://img.shields.io/crates/v/winnow.svg)](https://crates.io/crates/winnow)
+
+## About
+
+Build up a parser for your format of choice with the building blocks provided by `winnow`.
+
+For more details, see:
+- [Tutorial](https://docs.rs/winnow/latest/winnow/_tutorial/index.html)
+- [Special Topics](https://docs.rs/winnow/latest/winnow/_topic/index.html)
+ - [Why winnow? How does it compare to ...?](https://docs.rs/winnow/latest/winnow/_topic/why/index.html)
+- [API Reference](https://docs.rs/winnow)
+- [List of combinators](https://docs.rs/winnow/latest/winnow/combinator/index.html)
+
+# Contributors
+
+winnow is the fruit of the work of many contributors over the years, many
+thanks for your help! In particular, thanks to [Geal](https://github.com/Geal)
+for the original [`nom` crate](https://crates.io/crates/nom).
+
+<a href="https://github.com/winnow-rs/winnow/graphs/contributors">
+ <img src="https://contributors-img.web.app/image?repo=winnow-rs/winnow" />
+</a>