From 93b3090cb989617a985e3be410a0414fe9602bb8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Dawid=20Wysoki=C5=84ski?= <contact@dwysokinski.me>
Date: Fri, 9 Dec 2022 05:37:27 +0000
Subject: [PATCH] chore: README.md (#3)

Reviewed-on: https://gitea.dwysokinski.me/twhelp/sessions-ext/pulls/3
---
 README.md | 37 +++++++++++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a6cf538
--- /dev/null
+++ b/README.md
@@ -0,0 +1,37 @@
+# sessions
+
+A browser extension aiming to simplify coplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Coplayers can finally play together via a browser!
+
+## Getting started
+
+### Development
+
+#### Setting up the environment
+
+Prerequisites:
+
+1. **Node.js** (LTS)
+2. **IDE/Code editor** (e.g. WebStorm, VSCode, vim, neovim)
+3. **web-ext** (``yarn global add web-ext``)
+4. **backend** (such as [this one](https://gitea.dwysokinski.me/twhelp/sessions))
+5. **Chromium-based browser** (e.g. Chromium, Vivaldi, Brave)
+
+```shell
+# start a dev server
+yarn watch
+
+# launch a browser (e.g. Chromium)
+yarn run:chromium
+```
+
+## FAQ
+
+1. What data are sent to the backend? - Only sid (session identifier). Sid is [encrypted/decrypted on the client side](./src/crypto.ts).
+
+## License
+
+Distributed under the MIT License. See ``LICENSE`` for more information.
+
+## Contact
+
+Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)