1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..649f4db
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# qgs
+
+[![Package Version](https://img.shields.io/hexpm/v/qgs)](https://hex.pm/packages/qgs)
+[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/qgs/)
+
+```sh
+gleam add qgs@1
+```
+```gleam
+import qgs
+
+pub fn main() {
+  // TODO: An example of the project in use
+}
+```
+
+Further documentation can be found at <https://hexdocs.pm/qgs>.
+
+## Development
+
+```sh
+gleam run   # Run the project
+gleam test  # Run the tests
+```