Improve readme and contributing guidelines

Change-Id: I6787ec463e3daf25e5024f56a9deee6abd221098

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..599948e
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,60 @@
+# Contributing to Neoboard Miro Converter
+
+Thank you for your interest in contributing to the Neoboard Miro Converter project! We welcome contributions from the community. Please follow the guidelines below to ensure a smooth contribution process.
+
+## Getting Started
+
+1. Clone the repository with the Gerrit commit-msg hook:
+
+    ```bash
+    git clone "https://gerrit.midnightthoughts.space/neoboard-miro-converter" && (cd "neoboard-miro-converter" && mkdir -p `git rev-parse --git-dir`/hooks/ && curl -Lo `git rev-parse --git-dir`/hooks/commit-msg https://gerrit.midnightthoughts.space/tools/hooks/commit-msg && chmod +x `git rev-parse --git-dir`/hooks/commit-msg)
+    ```
+
+2. Create a new branch for your changes:
+
+    ```sh
+    git checkout -b my-feature-branch
+    ```
+
+3. Make your changes and commit them:
+
+    ```sh
+    git add .
+    git commit -m "Description of my changes"
+    ```
+
+4. Push your changes to Gerrit for review:
+
+    ```sh
+    git push origin HEAD:refs/for/main
+    ```
+
+## Code Review
+
+All changes must be reviewed and approved via Gerrit before they can be merged. Please be responsive to feedback and make any necessary revisions.
+
+For more information on using Gerrit, you can refer to the [Gerrit documentation](https://gerrit-review.googlesource.com/Documentation/index.html).
+
+## Additional Notes
+
+- Ensure your code follows the project's coding standards.
+- Write tests for your changes if applicable.
+- Update documentation as needed.
+
+## Using git-review
+
+To simplify the process of pushing changes to Gerrit, you can use the `git-review` tool. Install it using:
+
+```sh
+pip install git-review
+# Set up git-review in the repository
+git-review -s
+```
+
+Then, you can push your changes with:
+
+```sh
+git-review main
+```
+
+Thank you for your contributions to the Neoboard Miro Converter project! 🎉

diff --git a/README.md b/README.md
index ad1da7a517f65b8368a0d072e094cdbbed79adb4..ed02e28cfee37f10e8658c6992ed327dc080a94c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,8 +1,43 @@
-# Miro to Neoboard converter
+# Miro to Neoboard Converter
 
-This is a tool to convert a Miro board to a Neoboard board.
+This tool converts Miro boards to a format that can be imported into the Matrix Neoboard whiteboard developed by Nordeck.
 
-Note that this is highly experimental. You also require a Mira app for this.
+## Overview
+
+The Miro to Neoboard Converter is designed to help users seamlessly transition their Miro boards into the Neoboard format. This is particularly useful for teams and organizations that use both Miro and Neoboard for their collaborative whiteboarding needs.
+
+**Note:** This tool is highly experimental and requires a Miro app for proper functionality.
+
+## Features
+
+- Convert single or multiple Miro boards to Neoboard format.
+- Preserve shapes, text, and other elements during the conversion.
+- Ensure compatibility with the Neoboard whiteboard developed by Nordeck.
+
+## Limitations
+
+- The converter may not support all Miro elements or features.
+- It only works for frames. It does not export the entire board.
+
+## Prerequisites
+
+- Node.js installed on your machine.
+- A Miro app with the necessary credentials.
+
+## Installation
+
+1. Clone the repository:
+
+    ```sh
+    git clone "https://gerrit.midnightthoughts.space/neoboard-miro-converter"
+    cd neoboard-exporter
+    ```
+
+2. Install the dependencies:
+
+    ```sh
+    pnpm install
+    ```
 
 ## Usage
 
@@ -17,3 +52,23 @@ 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.
+
+### Running the Converter
+
+1. Build the project:
+
+    ```sh
+    pnpm run build
+    ```
+
+2. Start the development server:
+
+    ```sh
+    pnpm run start
+    ```
+
+3. Open your browser and navigate to `http://localhost:3000` to use the converter.
+
+## Contributing
+
+We welcome contributions! Please read our [contributing guidelines](CONTRIBUTING.md) for more details.

diff --git a/src/app/selectionFormComponent.tsx b/src/app/selectionFormComponent.tsx
index fe832882b2998465c14ac544872fcb9e93baf2db..2607b4de005fca40c7af387a3a8ce22f57537941 100644 (file)
--- a/src/app/selectionFormComponent.tsx
+++ b/src/app/selectionFormComponent.tsx
@@ -60,7 +60,6 @@ export default function SelectionFormComponent({ boards }: SelectionFormProps) {
     return (
         <div>
             <h3>Available Boards</h3>
-            <p><i>Due to limitations of the Miro API we can not correctly export boards which used templates</i></p>
             <form action={action}>
                 <p>This is a list of all the boards you have access to. Please select a board to import</p>