From e1b994bae17369f75b9ca0dba4cc37dae4e79371 Mon Sep 17 00:00:00 2001
From: Gareth Pendleton <gareth.sidebottom@gmail.com>
Date: Fri, 31 Oct 2025 22:09:01 +0000
Subject: [PATCH] docs: Update README

---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

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 <https://hexdocs.pm/lancaster_stemmer>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```