Skip to content

Commit b9cc617

Browse files
committed
docs: introduction
Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>
1 parent 64f2e70 commit b9cc617

File tree

1 file changed

+25
-2
lines changed

1 file changed

+25
-2
lines changed

README.md

Lines changed: 25 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ It implements the [**unist**][unist] spec.
2020
## Contents
2121

2222
- [Introduction](#introduction)
23+
- [Where this specification fits](#where-this-specification-fits)
2324
- [Types](#types)
2425
- [Nodes (abstract)](#nodes-abstract)
2526
- [Nodes](#nodes)
@@ -30,7 +31,12 @@ It implements the [**unist**][unist] spec.
3031

3132
## Introduction
3233

33-
**TODO**: introduction
34+
This document defines a format for representing file systems as abstract syntax trees. Development of fst started in
35+
January 2025. This specification is written in a [TypeScript][]-like grammar.
36+
37+
### Where this specification fits
38+
39+
fst extends [unist][], a format for syntax trees, to benefit from its [ecosystem of utilities](#list-of-utilities).
3440

3541
## Types
3642

@@ -60,6 +66,11 @@ See the [unist glossary][unist-glossary] for more terms.
6066

6167
See the [unist list of utilities][unist-utilities] for more utilities.
6268

69+
- [`fst-util-from-fs`][fst-util-from-fs] — create trees from file systems
70+
- [`unist-util-builder`][unist-util-builder] — build trees
71+
- [`unist-util-inspect`][unist-util-inspect] — inspect trees
72+
- [`unist-util-visit`][unist-util-visit] — visit nodes using [preorder][] or [postorder][] traversal
73+
6374
## Contribute
6475

6576
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
@@ -71,7 +82,13 @@ community you agree to abide by its terms.
7182

7283
[fst-ideas]: https://github.com/flex-development/fst/discussions/new?category=idea
7384

74-
<!-- [fst-util-from-fs]: https://github.com/flex-development/fst-util-from-fs -->
85+
[fst-util-from-fs]: https://github.com/flex-development/fst-util-from-fs
86+
87+
[postorder]: https://github.com/syntax-tree/unist#postorder
88+
89+
[preorder]: https://github.com/syntax-tree/unist#preorder
90+
91+
[typescript]: https://www.typescriptlang.org
7592

7693
<!-- [unist-child]: https://github.com/syntax-tree/unist#child -->
7794

@@ -91,6 +108,12 @@ community you agree to abide by its terms.
91108

92109
<!-- [unist-tree]: https://github.com/syntax-tree/unist#tree -->
93110

111+
[unist-util-builder]: https://github.com/flex-development/unist-util-builder
112+
113+
[unist-util-inspect]: https://github.com/flex-development/unist-util-inspect
114+
115+
[unist-util-visit]: https://github.com/flex-development/unist-util-visit
116+
94117
[unist-utilities]: https://github.com/syntax-tree/unist#list-of-utilities
95118

96119
[unist]: https://github.com/syntax-tree/unist

0 commit comments

Comments
 (0)