updated the README

Author: nikolasfil

README.md

@@ -1,11 +1,34 @@
-How to install the project
+# CTFSolverScript
 
-```bash
-python setup.py bdist_wheel sdist
-```
+CTFSolverScript is a tool designed to assist in solving Capture The Flag (CTF) challenges. It provides utilities and scripts to streamline the process of solving various types of CTF problems.
+
+## Features
 
-For local installation use:
+- **Automated Scripts**: Pre-built scripts for common CTF tasks.
+- **Modular Design**: Easily extendable to add custom scripts.
+- **Cross-Platform**: Works on Linux, macOS, and Windows.
+- **Lightweight**: Minimal dependencies for quick setup.
+
+## Installation
+
+[official pypi link](https://pypi.org/project/ctfsolver)
 
 ```bash
-pip install .
+pip install ctfsolver
 ```
+
+## Usage
+
+Either as a class or as a command-line tool.
+More documentation on the way.
+For now the documentation is autogenerated from docstrings using pdoc3
+
+[ctfsolver](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contact
+
+Feel free to open a ticket on the [GitHub Issues page](https://github.com/nikolasfil/CTFSolverScript/issues) for any questions or suggestions.