diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..49bd409
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,13 @@
+# cardputer-bsc-nostd
+
+A `no_std` board support crate for the m5stack cardputer.
+
+## Examples
+
+The `examples` directory contains small example crates that use `cardputer-bsc-nostd`. You can build and flash an example to your cardputer using the following commands:
+
+```shell
+git clone https://forgejo.zacjw.com/zac/cardputer-bsc-nostd.git
+cd cardputer-bsc-nostd
+cargo espflash flash --release --package <name-of-example>
+```