From 57e7a3513a7d247923288e05f9dd0cbc8ef288fd Mon Sep 17 00:00:00 2001
From: Melody Horn <melody@boringcactus.com>
Date: Sun, 27 Mar 2022 00:19:57 -0600
Subject: add README with high-level usage examples

---
 README.md | 84 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 84 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d0a2811
--- /dev/null
+++ b/README.md
@@ -0,0 +1,84 @@
+# kdl-schema
+
+[KDL Schema](https://github.com/kdl-org/kdl/blob/1.0.0/SCHEMA-SPEC.md) types and parsing.
+
+## examples
+
+### building a schema
+
+```rust
+use kdl_schema::*;
+let schema = Schema {
+    document: Document {
+        info: Info {
+            title: vec![TextValue {
+                text: "Sample Schema".to_string(),
+                lang: Some("en".to_string()),
+            }],
+            ..Info::default()
+        },
+        nodes: vec![Node {
+            name: Some("name".to_string()),
+            values: vec![Value {
+                validations: vec![Validation::Type("string".to_string())],
+                ..Value::default()
+            }],
+            ..Node::default()
+        }]
+    }
+};
+println!("{:?}", schema);
+```
+
+### parsing a schema KDL
+
+```rust
+#[cfg(feature = "parse-knuffel")] {
+    let schema_kdl = r#"
+document {
+    info {
+        title "Sample Schema" lang="en"
+        description "An example schema" lang="en"
+        author "boringcactus"
+    }
+    node "name" {
+        value {
+            type "string"
+        }
+    }
+    node "age" {
+        value {
+            type "number"
+        }
+    }
+}
+"#;
+    let _matching_document = r#"
+name "Joe"
+age 69
+"#;
+    let schema = kdl_schema::Schema::parse(schema_kdl).unwrap();
+    assert_eq!(schema.document.info.title[0].text, "Sample Schema");
+}
+```
+
+### referencing the schema schema
+
+```rust
+assert_eq!(kdl_schema::SCHEMA_SCHEMA.document.info.title[0].text, "KDL Schema");
+```
+
+## cargo features
+
+- `parse-knuffel` - expose `Schema::parse`, powered by [the `knuffel` crate](https://crates.io/crates/knuffel)
+
+## conditions blocking version 1.0.0
+
+- types actually match the schema (currently I'm omitting several things because the schema schema doesn't use them)
+- ergonomic builder API to define a schema in Rust in a non-ugly way
+- can generate KDL
+- can choose kdl or knuffel as parser
+
+## license
+
+[Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0).
-- 
cgit v1.2.3