diff --git a/README.md b/README.md index 9bbb678..d385f58 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # lancaster_stemmer -Gleam implementation of the Lancaster (Paice/Husk) Stemmer \ No newline at end of file +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 . + +## Development + +```sh +gleam run # Run the project +gleam test # Run the tests +```