diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..f4e512a --- /dev/null +++ b/README.md @@ -0,0 +1,44 @@ +# Germ + +[](https://crates.io/crates/germ) +[](https://docs.rs/germ) +[](https://github.com/gemrest/germ/actions/workflows/check.yaml) + +The Ultimate Gemini Toolkit. + +Germ is a toolkit for the Gemini protocol which aims to have a little something +for everyone. At the moment, Germ has **ZERO** dependencies, and Germ will +continue to try its hardest to have as few dependencies as possible. + +## Features + +- AST builder to easily construct AST trees from raw Gemtext. +- Converters to easily convert from Gemtext to markup formats such as HTML or + Markdown. +- More to come! + +## Usage + +```toml +# Cargo.toml + +[dependencies] +germ = "0.1.0" +``` + +### Features + +| Feature | Description | +|-----------|------------------------------------------------------------------| +| `ast` | Construct AST trees from raw Gemtext. | +| `convert` | Convert from Gemtext to markup formats such as HTML or Markdown. | + +### Examples + +Examples can be found within the +[`examples/`](https://github.com/gemrest/germ/tree/main/examples) directory. + +## License + +This project is licensed with the +[GNU General Public License v3.0](https://github.com/gemrest/germ/blob/main/LICENSE). |