it's not much, but it's a start

README.md

@@ -8,19 +8,73 @@ with their vaults, publishing them via static site generators or doing
 quality control with scheduled tasks.
 
 # Features
+`obp` is in pre-release status for now, so the featureset is limited.
+
+```
+obp-linux help
+a suite of tools for managing your obsidian vault
+
+Usage:
+  obp [command]
+
+Available Commands:
+  completion  Generate the autocompletion script for the specified shell
+  help        Help about any command
+  validate    loads a note and ensures its frontmatter follows the provided protobuf schema
+
+Flags:
+      --config string   config file (default "~/.obp.toml")
+  -h, --help            help for obp
+
+Additional help topics:
+  obp hugo       convert a set of Obsidian notes into a Hugo compatible directory structure
+
+Use "obp [command] --help" for more information about a command.
+
+```
 ## Validation
-Markdown allows you to preface your document with another, typically in
+
-YAML, that contains metadata about the document. A common use-case for this is
+Using the validation feature requires that the JSONSchema files are hosted on
-in static site generators; Hugo checks your Markdown document's frontmatter for
+some HTTP server somewhere. I did this to simplify the code and avoid resolving
-properties like `title` to help it make rendering decisions.
+relative pathing along the dependency tree.
-
+
-When you have data, making sure it's consistent is pretty important. For example,
+You can find some pre-made schemas [here](https://schemas.ndumas.com), a site
-Hugo uses the boolean `draft` property to determine whether a post will be
+powered by my [json-schemas](https://github.com/therealfakemoot/json-schemas) repository. If you
-included in the generated site output. A personal blog is a low
+would like to submit a schema that you've designed.
-stakes example, but a business managing internal vs external documentation
+
-or otherwise enforcing standards could save themselves a lot of effort and
+### Usage
-headache if it were possible to automate the process of verifying the layout
+```
-and disposition of their data.
+Usage:
-
+  obp validate [flags]
-The good news is that we don't have to invent anything here. Schemas exist
+
-precisely for this reason
+Flags:
+      --format string   output format [markdown, json, csv] (default "markdown")
+  -h, --help            help for validate
+  -s, --schema string   path to protobuf file (default "base.schema")
+  -t, --target string   directory containing validation targets
+
+Global Flags:
+      --config string   config file (default "~/.obp.toml")
+```
+
+Markdown output can be piped into [glow](https://github.com/charmbracelet/glow) for a little
+extra pizazz, but JSON is available for programmatic handling.
+```
+./bin/obp-linux validate --format markdown -s https://schemas.ndumas.com/obsidian/note.schema.json -t Resou
+rces/blog/published/|glow
+
+   Validation Errors for "/home/ndumas/work/obsidian-pipeline/Resources/blog/published/schema-bad-tags.md"
+
+          VALIDATION RULE       │ FAILING PROPERTY │             ERROR
+  ──────────────────────────────┼──────────────────┼─────────────────────────────────
+    /properties/tags/items/type │ /tags/2          │ expected string, but got
+                                │                  │ number
+
+   Validation Errors for "/home/ndumas/work/obsidian-pipeline/Resources/blog/published/schema-bad.md"
+
+          VALIDATION RULE        │ FAILING PROPERTY │             ERROR
+  ───────────────────────────────┼──────────────────┼─────────────────────────────────
+    /properties/description/type │ /description     │ expected string, but got
+                                 │                  │ number
+    /properties/tags/type        │ /tags            │ expected array, but got string
+```