From c6f41e53dddf858bda270181a7a94d3185fb74ac Mon Sep 17 00:00:00 2001 From: Jeremy Wall Date: Mon, 12 Mar 2018 20:46:51 -0500 Subject: [PATCH] README and TODO fixes and expansion. --- README.md | 10 ++++++++-- TODO.md | 1 - 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 40acb36..526811c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Universal Configuration Grammar - Working Title. +# Universal Configuration Grammar. This is an experiment in configuration management. The approach is **not** to create a "parsable" config file format. We have plenty of @@ -14,6 +14,12 @@ be version controlled, enforce _some_ typesafety, and output configuration for any application regardless of that applications preferred format. +## The Usual Warnings + +This is still very much an experiment and the language and api can be expected +to change and mutate. It also probably has bugs and isn't yet the most user +friendly language and compiler to use. You have been warned. + ## Usage You can get ucg with cargo `cargo install ucg`. @@ -38,4 +44,4 @@ SUBCOMMANDS: ## Language Reference -https://docs.rs/ucg/0.0.1/ \ No newline at end of file +https://docs.rs/ucg/ \ No newline at end of file diff --git a/TODO.md b/TODO.md index 80112d4..cb6eed6 100644 --- a/TODO.md +++ b/TODO.md @@ -19,5 +19,4 @@ organiztion for a given configuration structure. Some options here could be * Allow trailing commas * Flags should allow different seperators for prefixed flags. -* None value types * YAML export \ No newline at end of file