From: MTRNord <mtrnord1@gmail.com>
Date: Sat, 11 Jan 2025 19:02:42 +0000 (+0100)
Subject: Remove the unused app submission file and add info about the required .env file in... 
X-Git-Url: https://gerrit.midnightthoughts.space/gitweb?a=commitdiff_plain;h=194150b1d052362855b3ba6c87624bec642bec58;p=neoboard-miro-converter.git

Remove the unused app submission file and add info about the required .env file in the README

Change-Id: Idc1dfea1bbbc23e28c37f053e97e939462544154
---

diff --git a/APP_SUBMISSION.md b/APP_SUBMISSION.md
deleted file mode 100644
index 0d3d2f0..0000000
--- a/APP_SUBMISSION.md
+++ /dev/null
@@ -1,5 +0,0 @@
-## Submission to Miro Marketplace
-
-Congrats! You have finished building your app & you'd like to publish it for
-users. You can submit your app on the
-[Miro Marketplace](https://developers.miro.com/docs/submit-your-app) for review.
diff --git a/README.md b/README.md
index 34d150b..ad1da7a 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,17 @@
 This is a tool to convert a Miro board to a Neoboard board.
 
 Note that this is highly experimental. You also require a Mira app for this.
+
+## Usage
+
+### Adding an .env file
+
+Create a `.env` file in the root of the project with the following content:
+
+```environment
+MIRO_CLIENT_ID="<your miro client id>"
+MIRO_CLIENT_SECRET="<your miro client secret>"
+MIRO_REDIRECT_URL="http://localhost:3000/api/redirect"
+```
+
+If you are publicly hosting this, you should change the `MIRO_REDIRECT_URL` to the URL of your server.