Add README

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..7188b9e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# pom-rs
+
+Rust parser for [POM configuration language](https://pom.computer)
+
+## Basic usage
+
+```rust
+use pom_parser::Configuration;
+let conf = Configuration::load_path("examples/conf.pom").expect("bad configuration");
+let indentation_type = conf.get("indentation-type");
+match indentation_type {
+	Some(t) => println!("indenting with {t}!"),
+	None => println!("no indentation type set!"),
+}
+let tab_size = conf.get_int_or_default("tab-size", 4)
+	.expect("invalid number for tab-size!");
+println!("tab size: {tab_size}");
+```
+
+See `examples/` for more examples.
+
+## License
+
+```text
+Permission to use, copy, modify, and/or distribute this software for
+any purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL
+WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE
+FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY
+DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
+AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT
+OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+```