updated the readme

Author: nikolasfil

README.md

@@ -2,33 +2,65 @@
 
 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.
 
+This library has been created to suit my needs.
+
+What I mean is, I was developing it when I was solving CTF challenges.
+By solving the ctf's with python, and automating the solutions, I collected many scripts.
+
+Some functionalities came by request, some I implemented out of personal interest.
+
+Some things will seem weird to others, such as the structure of the challenge folder, and the keywords used.
+
+The documentation is still under development.
+
 ## Features
 
 - **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)
+[installation instructions can be found here.](docs/sphinx/source/modules/installation.md)
+
+## Usage
+
+Can be used as a class for scripting and as a cli tool
 
 ```bash
-pip install ctfsolver
+ctfsolver --help
 ```
 
-## Usage
+```
+ctfsolver help
+```
+
+[detailed usage instructions can be found here.](docs/sphinx/source/modules/usage.md)
+
+[Automated Documentation can be found here.](https://nikolasfil.github.io/CTFSolverScript/)
+
+When the repo is cloned locally you can find pdoc and sphinx generated documentation in the docs/ folder.
+
+```bash
+make doc-pdoc-host
+```
+
+```bash
+make doc-sphinx-host
+```
+
+## Contributing
 
-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
+Contributions are welcome! Please follow these steps:
 
-[ctfsolver](https://nikolasfil.github.io/CTFSolverScript/ctfsolver/)
+1. Fork the repository.
+2. Create a new branch for your feature or bugfix.
+3. Submit a pull request with a detailed description of your changes.
 
 ## 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.
+For questions or suggestions, feel free to open an issue or contact the maintainer at `filippatos.nikolas@gmail.com`.