Skip to content

Commit

Permalink
Make documentation easier to find
Browse files Browse the repository at this point in the history
  • Loading branch information
Geal committed Sep 11, 2016
1 parent 377481c commit 92d13e8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ oldsrc/
realworld/
src/generator.rs
.DS_Store
docs/
private-docs/
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ nom can handle any format, binary or textual, with grammars from regular to cont

If you need any help developing your parsers, please ping `geal` on IRC (mozilla, freenode, geeknode, oftc), go to `#nom` on Mozilla IRC, or on the [Gitter chat room](https://gitter.im/Geal/nom).

Reference documentation is available [here](http://rust.unhandledexpression.com/nom/).

Various design documents and tutorials can be found in the [docs directory](https://github.com/Geal/nom/tree/master/docs).

## Features

Here are the current and planned features, with their status:
Expand All @@ -30,8 +34,6 @@ Here are the current and planned features, with their status:
- [x] **safe parsing**: nom leverages Rust's safe memory handling and powerful types, and parsers are routinely fuzzed and tested with real world data. So far, the only flaws found by fuzzing were in code written outside of nom
- [x] **speed**: benchmarks have shown that nom parsers often outperform many parser combinators library like Parsec and attoparsec, some regular expression engines and even handwritten C parsers

Reference documentation is available [here](http://rust.unhandledexpression.com/nom/).

Some benchmarks are available on [Github](https://github.com/Geal/nom_benchmarks).

## Installation
Expand Down

0 comments on commit 92d13e8

Please sign in to comment.