From 9e7889730253e4ba269346dde3fe89e8ef75f1cd Mon Sep 17 00:00:00 2001
From: kieran <kieran@harkin.me>
Date: Thu, 13 Feb 2025 15:24:04 +0000
Subject: [PATCH] chore: readme

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..65af9f8
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# NAP
+
+Nostr Application Publisher
+
+## Install
+
+Install rust toolchain with [rustup](https://rustup.rs/)
+
+Install `nap`:
+```bash
+cargo install --git https://git.v0l.io/Kieran/nap
+```
+
+Create your `nap.yaml` config file:
+
+```yaml
+# Unique app id
+id: "io.nostrlabs.freeflow"
+
+# Display name of the app
+name: "Freeflow"
+
+# Human-readable long description
+description: "Live in the moment"
+
+# Application icon
+icon: "https://freeflow.app/icon.png"
+
+# Banner / Preview of the app
+images:
+  - "https://freeflow.app/banner.jpg"
+
+# Public code repo or project website
+repository: "https://github.com/nostrlabs-io/freeflow"
+
+# SPDX code license
+license: "MIT"
+
+# Descriptive app tags
+tags:
+  - "tiktok"
+  - "shorts"
+```
+
+Publish the app by running `nap` in your project folder and follow the prompts. 
\ No newline at end of file