diff --git a/README.md b/README.md new file mode 100644 index 0000000..73f13c2 --- /dev/null +++ b/README.md @@ -0,0 +1,32 @@ +# LibreFi +## Free Wi-Fi was so great that we created Free Wi-Fi 2 + + +## How to use (for now): +```sh +$ git clone https://git.sakamoto.pl/laudom/librefi.git +$ cd librefi +$ pip3 install -r ./librefi/requirements.txt +$ python3 -m librefi # no daemon yet, run to connect +``` + +## A bit of technical things +- Requires Python 3.8+ for now. +- Requires NetworkManager (only Linux and some Unix-like systems) to connect with Wi-Fi networks for now. +- Only tested with CPython for now. +- Only works with [these networks](https://git.sakamoto.pl/laudom/librefi/-/blob/master/librefi/fxckers/_map.py) + +## Contributing +If you want to contribute, please contact with either [Laura](https://selfisekai.rocks) or [Dominika](https://sakamoto.pl) for a [git.sakamoto.pl](https://git.sakamoto.pl) account, or just [submit patches by e-mail](https://devconnected.com/how-to-create-and-apply-git-patch-files/#Create_Git_Patch_Files) to + +## Maintainers: +### Core: +- Laura Liberda +- Dominika Liberda +### Fxckers: +- Poland: + - Warsaw: + - Laura Liberda + - Dominika Liberda + - Opole: + - Laura Liberda