diff --git a/README.md b/README.md index 0f3b41f..ed6458e 100644 --- a/README.md +++ b/README.md @@ -8,23 +8,21 @@ ## Features * **No database required.** Everything is stored in plain files. It makes installation super easy, and you can modify the content directly by yourself. -* **Everything is hyphae.** A [hypha] is a unit of content such as a picture, video or a text article. Hyphae can [transclude][transclusion] and link each other resulting in a tight network of hypertext pages. +* **Everything is hyphae.** A hypha is a unit of content such as a picture, video or a text article. Hyphae can [transclude] and link each other, forming a tight network of hypertext pages. * **Hyphae are authored in [Mycomarkup],** a markup language that's designed to be unambigious yet easy to use. -* **Categories.** -* **Nesting of hyphae** is also supported. -* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included! +* **Categories** let you organize hyphae without any hierarchy restrictions, with all the benefits of a tag system. +* **Nesting of hyphae** is also supported if you like hierarchies. +* **History of changes** for textual parts of hyphae. Every change is safely stored in [Git]. Web feeds for recent changes included. * **Keyboard-driven navigation.** Press `?` to see the list of shortcuts. -* **Support for [authorization].** -* **[Open Graph] support.** -* **Optional [Telegram] authentication.** +* **Support for [authorization].** Both plain username-password pairs and [Telegram]'s login widget are supported. +* **[Open Graph] support.** The most relevant info about a hypha is made available through OG meta tags for consumption by other software. -[hypha]: https://mycorrhiza.wiki/hypha/feature/hypha -[transclusion]: https://mycorrhiza.wiki/hypha/feature/transclusion -[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization +[transclude]: https://mycorrhiza.wiki/hypha/feature/transclusion [Mycomarkup]: https://mycorrhiza.wiki/help/en/mycomarkup [Git]: https://mycorrhiza.wiki/hypha/integration/git -[Open Graph]: https://mycorrhiza.wiki/hypha/standard/opengraph +[authorization]: https://mycorrhiza.wiki/hypha/feature/authorization [Telegram]: https://mycorrhiza.wiki/help/en/telegram +[Open Graph]: https://mycorrhiza.wiki/hypha/opengraph Compare Mycorrhiza Wiki with other engines on [WikiMatrix](https://www.wikimatrix.org/show/mycorrhiza). @@ -36,18 +34,12 @@ See [the deployment guide](https://mycorrhiza.wiki/hypha/guide/deployment) on th ## Contributing -* [GitHub](https://github.com/bouncepaw/mycorrhiza) * [SourceHut](https://sr.ht/~bouncepaw/mycorrhiza) +* [GitHub](https://github.com/bouncepaw/mycorrhiza) * [#mycorrhiza on irc.libera.chat](irc://irc.libera.chat/#mycorrhiza) * [@mycorrhizadev (Russian) in Telegram](https://t.me/mycorrhizadev) -If you want to contribute with code, open a pull request on GitHub or send a -patch to the [mailing list]. If you want to report an issue, open an issue on -GitHub or contact us directly. +If you want to contribute with code, open a pull request on GitHub or send a patch to the [mailing list](https://lists.sr.ht/~bouncepaw/mycorrhiza-devel). +If you want to report an issue, open an issue on GitHub or contact us directly. Consider supporting the development on [Boosty](https://boosty.to/bouncepaw). - -You can view the list of planned features on the [roadmap page]. - -[mailing list]: https://lists.sr.ht/~bouncepaw/mycorrhiza-devel -[roadmap page]: https://mycorrhiza.wiki/hypha/release/roadmap