chore: README.md

README.md

@@ -0,0 +1,33 @@
+# sessions
+
+A browser extension aiming to simplify cooplaying in [Tribal Wars](https://www.tribalwars.net/en-dk/). Cooplayers can finally play at the same time via a browser!
+
+## Getting started
+
+### Development
+
+#### Set 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
+```
+
+## License
+
+Distributed under the MIT License. See ``LICENSE`` for more information.
+
+## Contact
+
+Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)