Update README

DEVELOPMENT_INSTALL.md

@@ -0,0 +1,30 @@
+# Installing development releases of Yokkaichi from git
+- Installing the development releases with pipx (from git)
+```
+git clone https://github.com/Oreeeee/yokkaichi
+cd yokkaichi/
+git checkout master # for semi-stable code
+git checkout dev # for development code. Might not run at all!!!!
+pipx install . --force --include-deps
+yokkaichi -v
+```
+- Temporarily installing the development releases with pipx (from git)
+```
+git clone https://github.com/Oreeeee/yokkaichi
+cd yokkaichi/
+git checkout master # for semi-stable code
+git checkout dev # for development code. Might not run at all!!!!
+pipx run --spec ./ yokkaichi -v
+```
+- Installing the development releases in virtual environment (from git)
+```
+git clone https://github.com/Oreeeee/yokkaichi
+cd yokkaichi/
+git checkout master # for semi-stable code
+git checkout dev # for development code. Might not run at all!!!!
+virtualenv .venv
+source .venv/bin/activate # for Linux
+.venv\bin\activate.bat # for Windows
+pip install -e .
+yokkaichi -v
+```

README.md

@@ -15,23 +15,33 @@ This project used to be named mcserverscanner, but on 2023-01-15 it got renamed
 ### Planned features (not in a specific order)
 - WWW interface
 - Bot joining the servers
-- Cleaning up the code
 - Docker support
 - Scanning for pre-Netty (<1.7) servers
 - Query integration
 
 ### Installation
-- Easy installation (from PyPI)
+#### Releases
+- Installing the latest version with pipx (recommended)
 ```
-pip install yokkaichi
+pipx install yokkaichi --include-deps
+yokkaichi -v
 ```
-- Manual installation (from git)
+- Installing the latest version in a virtual environment
 ```
-git clone https://github.com/Oreeeee/yokkaichi
-cd yokkaichi
-pip install .
+virtualenv .venv
+source .venv/bin/activate # for Linux
+.venv\bin\activate.bat # for Windows
+pip install yokkaichi
+yokkaichi -v
 ```
 
+#### Development versions (not recommended!)
+Check out [DEVELOPMENT_INSTALL.md](https://github.com/Oreeeee/yokkaichi/blob/master/DEVELOPMENT_INSTALL.md)
+
+### 3rd party dependencies (optional)
+- `masscan` (for faster scanning)
+- `7z` or `7za` (for automatic IP2Location database updates)
+
 ### Usage
 When starting the script for the first time, `yokkaichi.toml` will get created. You will have to adjust it to your preferences. Optionally, you can also pass in `-c` to set a different name or location of the config file.