add sample usage

1 files changed, 22 insertions, 0 deletions

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..d3f4ad8
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,22 @@
+# fondant
+
+> an experimental, macro-only, boilerplate free, configuration management library
+
+### example
+
+```rust
+#[derive(Config, Default, Serialize, Deserialize)]
+#[filename = "config"] // ~/.config/appconfig/config.toml (XDG spec)
+#[extension = "toml"]  // possible values: yaml, toml, json
+struct AppConfig {
+    version: u8,
+    path: String,
+}
+
+fn main() {
+    let mut config = AppConfig::load().unwrap();
+    config.version = 3;
+    config.path = "/home/np".to_string();
+    config.store();
+}
+```