diff --git a/Cargo.toml b/Cargo.toml index 5b4a217..7e3226e 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -4,6 +4,7 @@ version = "0.1.0" authors = ["PoiScript "] description = "A Rust library for parsing orgmode files." repository = "https://github.com/PoiScript/orgize" +readme = "README.md" license = "MIT" keywords = ["orgmode","emacs","parser"] diff --git a/README.md b/README.md new file mode 100644 index 0000000..9abb908 --- /dev/null +++ b/README.md @@ -0,0 +1,48 @@ +# Orgize + +Orgize is a Emacs Org-mode parser written by pure Rust. It behaves like a pull +parser (returning an iterator of events) but not exactly. + +Besides, orgize also provides some mechanism for exporting org-mode files to +various formats, e.g. HTML. + +## Usage + +```toml +[dependencies] +orgize = "0.1.0" +``` + +```rust +// Rust 2015 only +extern crate orgize; +``` + +## Example + +```rust +use orgize::Parser; + +fn main() { + let parser = Parser::new( + r#"* Title 1 +*Section 1* +** Title 2 +_Section 2_ +* Title 3 +/Section 3/ +* Title 4 +=Section 4="#, + ); + + for event in parser { + // handling the event + } +} +``` + +Alternatively, you can use the built-in render. + +## License + +MIT