add README with high-level usage examples

1 files changed, 10 insertions, 0 deletions

diff --git a/src/lib.rs b/src/lib.rs
index 97dbce4..c724687 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,4 @@
+#![doc = include_str!("../README.md")]
 #![warn(clippy::pedantic, clippy::cargo)]
 
 #[cfg(feature = "parse-knuffel")]
@@ -17,6 +18,15 @@ pub struct Schema {
     pub document: Document,
 }
 
+#[cfg(feature = "parse-knuffel")]
+impl Schema {
+    pub fn parse(
+        schema_kdl: &str,
+    ) -> Result<Self, knuffel::Error<impl knuffel::traits::ErrorSpan>> {
+        knuffel::parse("<Schema::parse argument>", schema_kdl)
+    }
+}
+
 #[derive(Debug, PartialEq, Eq, Default)]
 #[cfg_attr(feature = "parse-knuffel", derive(Decode))]
 pub struct Document {