Add documentation in the README

.github/workflows/main.yml

@@ -98,6 +98,7 @@ jobs:
       - name: Install Linux build dependencies
         if: matrix.os == 'ubuntu-latest'
         run: sudo apt-get install --no-install-recommends -y libopenjp2-tools rpm libarchive-tools
+
       - name: Install dependencies
         working-directory: ${{ matrix.edition }}-src
         run: npm install

README.md

@@ -0,0 +1,61 @@
+# notion-repackaged
+
+Notion Repackaged is an effort to bring the Notion app to all major Linux distributions as well as providing a variant with [notion-enhancer](https://github.com/notion-enhancer/notion-enhancer) embedded for both Windows, Linux and MacOS.
+
+> This project is heavily inspired on [notion-linux](https://github.com/davidbailey00/notion-linux) but extending on the idea of embedding notion-enhancer, providing an easy way to use notion-enhancer on all operating systems.
+
+## Installation
+
+> :warning: Make sure you don't run the official (or vanilla) and enhanced versions at the same time. I would only install one or the other. You can't just have your cake and eat it too.
+
+### Windows
+
+Download the `exe` file from the release and install it, should be a pretty straightforward experience.
+
+You can also download the `zip` build for Windows which provides a portable way to run the application.
+
+### Linux
+
+For linux there are two variants, `vanilla` and `enhanced`. The vanilla is a direct port of the official sources and the enhanced includes `notion-enhancer`.
+
+Currently, we target the following package types:
+- AppImage (any distribution, not actively tested)
+- deb (Debian, Ubuntu, Pop!_OS, Linux Mint)
+- rpm (Fedora)
+- pacman (Arch Linux, Manjaro)
+- zip (any, portable)
+
+Please refer to your distribution's documentation on information on how to install these packages, but we try some of them like this:
+- `AppImage` are runnable binaries, so to install them just run them. 
+- `deb` can be installed running: `sudo dpkg -i <downloaded file>.deb`
+- `pacman` can be installed running: `sudo pacman -U <downloaded file>.pacman`
+  > AUR builds are highly recommended instead. Install [notion-app](https://aur.archlinux.org/packages/notion-app/) or [notion-app-enhanced](https://aur.archlinux.org/packages/notion-app-enhanced) respectively.
+
+### MacOS
+
+We also build the enhanced variant for MacOS but there are no concrete instructions as I have no way of trying the builds for myself.
+
+In theory, you should be able to download the `dmg` build and drag it to your dock to install it.
+
+The dmg archive produced is not signed, so chances are you'll not be able to use it, or even install it.
+
+Please, take look at the official instructions from Apple on how to install unsigned apps: https://support.apple.com/en-us/HT202491
+
+## Issues
+
+If you find yourself not being able to use our builds, please create an issue with a any and all information you can provide on how to reproduce and debug this issue. Screenshots and terminal logs are vital to being able to fix the issues.
+
+If you have an issue with the enhanced variant, please try using the vanilla variant. This step is crucial on the way to figuring our the root of the issue. Do not create issues in notion-enhancer before making sure it's not our fault, we modify notion-enhancer internally.
+
+## Contributing
+
+Any contribution is welcome, be it documentation, code improvements or fixes.
+We don't plan on improving notion-enhancer, we aim to be compatible with it and track their changes.
+
+## Disclaimer
+
+This project extracts the source code of the publicly-available binaries on the [official Notion website](https://www.notion.so/desktop), meaning all code contained within our packages is owned by Notion.
+
+Additionally, in the enhanced variant, we embed [notion-enhancer](https://github.com/notion-enhancer/notion-enhancer) which is MIT licensed. All code contained in the `embedded_enhancer` directory is owned by them, as well as the code the necessary patches are based off.
+
+This project is made as a best-effort in my free time. I am not liable for any problems caused by this (or included) software.