From: MTRNord <mtrnord1@gmail.com>
Date: Sat, 11 Jan 2025 18:30:17 +0000 (+0100)
Subject: Add tiny readme
X-Git-Url: https://gerrit.midnightthoughts.space/gitweb?a=commitdiff_plain;h=50507d0032b89bb8d4176bf21bb236f315f9c317;p=neoboard-miro-converter.git

Add tiny readme
---

diff --git a/README-template.md b/README-template.md
deleted file mode 100644
index 9c58c60..0000000
--- a/README-template.md
+++ /dev/null
@@ -1,39 +0,0 @@
-## Create a Miro app
-
-### How to start locally
-
-1. [Sign in](https://miro.com/login/) to Miro, and then create a
-   [Developer team](https://developers.miro.com/docs/create-a-developer-team)
-   under your user account.
-
-2. [Create an app in Miro](https://developers.miro.com/docs/build-your-first-hello-world-app#step-2-create-your-app-in-miro).
-
-- Click the **Create new app** button.
-- On the **Create new app** modal, give your app a name, assign it to your
-  Developer team, and then click **Create**.
-
-3. Configure the app:
-
-- In your account profile, go to **Your apps**, and then select the app you just
-  created to access its configuration page.
-- On the app configuration page, go to **App Credentials**, and copy the app
-  **Client ID** and **Client secret** values: you'll need to enter these values
-  in step 4 below.
-- Go to **App URL** and enter the following URL: `http://localhost:3000`
-- Go to **Redirect URI for OAuth2.0**, and enter the following redirect URL:
-  `http://localhost:3000/api/redirect`
-- Click **Options**. \
-  From the drop-down menu select **Use this URI for SDK authorization**.
-- Lastly, go to **Permissions**, and select the following permissions:
-  - `board:read`
-  - `board:write`
-
-4. Open the [`.env`](.env) file, and enter the app client ID and client secret
-   values that you saved at the beginning of step 3 above.
-5. Run `npm start` to start developing.
-
-When your server is up and running:
-
-- Go to [Miro.com](https://miro.com).
-- In your developer team, open a board.
-- To start your app, click the app icon in the app toolbar on the left.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..34d150b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,5 @@
+# Miro to Neoboard converter
+
+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.