diff --git a/README.md b/README.md index 3c09c92..b16af31 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,20 @@ kdl is still extremely new, and discussion about the format should happen over on the [discussions page](https://github.com/kdoclang/kdl/discussions). Feel free to jump in and give us your 2 cents! +## Design Principles + +1. Maintainability +1. Flexibility +1. Cognitive simplicity +1. Ease of de/serialization +1. Ease of implementation + +These are the guiding principles behind the design of KDL, in order of +importance. These principles will hopefully be useful in tie-breaking and +otherwise directing specific decisions when it comes down to it. They are +intentionally vague when it comes to specifics, but more concrete definitions +for each one will be settled on as the project matures. + ## Implementations * Rust: [kdl-rs](https://github.com/kdl-org/kdl-rs) diff --git a/SPEC.md b/SPEC.md index 477bd16..be5b792 100644 --- a/SPEC.md +++ b/SPEC.md @@ -42,7 +42,7 @@ file/stream (an `EOF`). When present in the list of Properties and Values, plain Values (those not attached to a Property), each "anonymous" value should be treated as a -Property whose key is its current index among _anonymous values_ in the same +Property whose key is its current index among _values_ in the same node, starting from 0, as a string. Named properties do not count towarrds this index.