Skip to content

Commit 518b698

Browse files
committed
Refactor readme
1 parent dff2e22 commit 518b698

File tree

1 file changed

+25
-41
lines changed

1 file changed

+25
-41
lines changed

readme.md

Lines changed: 25 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,55 @@
11
# `.github`
22

3-
Community health files for **unist** (**syntax-tree**).
4-
This repo hosts the [code of conduct][coc],
5-
a guide on how to get [support][],
6-
how to [contribute][],
7-
a [pull request template][pr],
8-
and [issue templates][issue].
3+
Community health files for `syntax-tree`.
94

105
## unified
116

12-
**unist** (**syntax-tree**) is a [unified collective][unified] project.
13-
Read how it’s governed in [`unifiedjs/collective`][collective].
7+
This organization is part of **[unified][github-unified]**.
8+
See [`unifiedjs/collective`][github-collective] on how it’s governed.
149

15-
## Awesome syntax-tree
10+
## Awesome `syntax-tree`
1611

17-
For a curated list of awesome syntax-tree,
18-
unist,
19-
hast,
20-
xast,
21-
mdast,
22-
and nlcst resources,
23-
see [awesome syntax-tree][awesome].
12+
See [`syntax-tree/awesome-syntax-tree`][github-awesome-syntax-tree] for a
13+
curated list of awesome resources.
14+
15+
## Code of conduct
16+
17+
This community has a [code of conduct][file-code-of-conduct].
18+
You must follow it when interacting with the community.
2419

2520
## Support
2621

27-
We’re glad you’re using these projects and we’d love to help.
28-
Take a look at [`support.md`][support] to find out how to help us help you.
22+
See [`support.md`][file-support] on how to get help.
2923

3024
## Contributing
3125

32-
We’re excited that you’re interested in contributing!
33-
Take a moment to read [`contributing.md`][contribute].
26+
See [`contributing.md`][file-contributing] on how to contribute.
3427

35-
Ideas for new utilities and tools can be posted in [`syntax-tree/ideas`][ideas].
28+
## Security
3629

37-
## Code of conduct
38-
39-
This project has a [code of conduct][coc].
40-
By interacting with this repository,
41-
organization,
42-
or community you agree to abide by its terms.
30+
See [`security.md`][file-security] if you found a security issue.
4331

4432
## License
4533

4634
This document has the following license:
47-
[CC-BY-4.0][license] © [Titus Wormer][author].
35+
[CC-BY-4.0][creativecommons-by] © [Titus Wormer][wooorm].
4836

4937
Other projects may be licensed differently.
5038

51-
[license]: https://creativecommons.org/licenses/by/4.0/
52-
53-
[author]: http://wooorm.com
54-
55-
[coc]: code-of-conduct.md
39+
[creativecommons-by]: https://creativecommons.org/licenses/by/4.0/
5640

57-
[contribute]: contributing.md
41+
[file-code-of-conduct]: code-of-conduct.md
5842

59-
[support]: support.md
43+
[file-contributing]: contributing.md
6044

61-
[awesome]: https://github.com/syntax-tree/awesome-syntax-tree
45+
[file-security]: security.md
6246

63-
[ideas]: https://github.com/syntax-tree/ideas
47+
[file-support]: support.md
6448

65-
[pr]: .github/pull-request-template.md
49+
[github-awesome-syntax-tree]: https://github.com/syntax-tree/awesome-syntax-tree
6650

67-
[issue]: .github/ISSUE_TEMPLATE
51+
[github-collective]: https://github.com/unifiedjs/collective
6852

69-
[unified]: https://github.com/unifiedjs
53+
[github-unified]: https://github.com/unifiedjs
7054

71-
[collective]: https://github.com/unifiedjs/collective
55+
[wooorm]: https://wooorm.com

0 commit comments

Comments
 (0)