Skip to content

Commit

Permalink
DOCS : README.
Browse files Browse the repository at this point in the history
  • Loading branch information
crdoconnor committed May 25, 2023
1 parent 810e2db commit dfd93f9
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,7 @@ title: StrictYAML
{% endraw %}
{% endif %}

StrictYAML is a [type-safe](https://en.wikipedia.org/wiki/Type_safety) YAML parser
that parses and validates a [restricted subset](features-removed) of the [YAML](what-is-yaml)
StrictYAML is a [type-safe](https://en.wikipedia.org/wiki/Type_safety) YAML parser that parses and validates a [restricted subset](features-removed) of the [YAML](what-is-yaml)
specification.

Priorities:
Expand All @@ -25,6 +24,8 @@ Priorities:
- Ability to read in YAML, make changes and write it out again with comments preserved.
- [Not speed](why/speed-not-a-priority), currently.

I built it largely so I could [write integration tests with it](https://github.com/hitchdev/hitchstory).

{% for story in quickstart %}
{{ story.name }}:
{% if 'yaml_snippet' in story.data['given'] %}
Expand Down

0 comments on commit dfd93f9

Please sign in to comment.