docs: Update README
Some checks failed
test / test (push) Has been cancelled

This commit is contained in:
2025-10-31 22:09:01 +00:00
parent 4f470cdf26
commit e1b994bae1

View File

@@ -1,3 +1,26 @@
# lancaster_stemmer # lancaster_stemmer
Gleam implementation of the Lancaster (Paice/Husk) Stemmer Gleam implementation of the Lancaster (Paice/Husk) Stemmer
[![Package Version](https://img.shields.io/hexpm/v/lancaster_stemmer)](https://hex.pm/packages/lancaster_stemmer)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/lancaster_stemmer/)
```sh
gleam add lancaster_stemmer@1
```
```gleam
import lancaster_stemmer
pub fn main() -> Nil {
// TODO: An example of the project in use
}
```
Further documentation can be found at <https://hexdocs.pm/lancaster_stemmer>.
## Development
```sh
gleam run # Run the project
gleam test # Run the tests
```