Skip to content

Commit

Permalink
docs(readme): clean up
Browse files Browse the repository at this point in the history
  • Loading branch information
Fuwn committed Mar 25, 2024
1 parent 8dd15d5 commit 0f84d1c
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![docs.rs](https://docs.rs/germ/badge.svg)](https://docs.rs/germ)
[![github.com](https://github.com/gemrest/germ/actions/workflows/check.yaml/badge.svg?branch=main)](https://github.com/gemrest/germ/actions/workflows/check.yaml)

The Ultimate Gemini Toolkit.
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 (unless you use the
Expand All @@ -13,10 +13,14 @@ dependencies as possible.

## Features

- AST builder to easily construct AST trees from raw Gemtext.
- AST builder to easily construct and manipulate AST trees from raw Gemtext
- Converters to easily convert from Gemtext to markup formats such as HTML or
Markdown.
- More to come!
Markdown
- Blocking and non-blocking request suite
- Structured meta section manipulation
- And more!

Check out the rest of the features in the Features section under Usage

## Usage

Expand All @@ -27,10 +31,10 @@ Current version:
# Cargo.toml

[dependencies]
# To enable all features
# To enable only the base (default) features: ast, convert, meta, request
# germ = "*" # Use current version show above!

# To enable certain features
# To enable only certain features
[dependencies.germ]
version = "*" # Use current version show above!
default-features = false
Expand Down

0 comments on commit 0f84d1c

Please sign in to comment.