Create README.md

README.md

@@ -0,0 +1,57 @@
+# Welcome to LlamaTor
+
+![LlamaTor Version](https://img.shields.io/badge/version-0.0.0-blue.svg?cacheSeconds=2592000)
+
+LlamaTor is a community-driven project that provides a decentralized, efficient, and user-friendly method for downloading AI models. This tool enables the creation and sharing of torrent files for AI models, leveraging the robustness of the BitTorrent protocol to ensure model distribution is not solely dependent on any centralized site.
+
+## Features
+
+- Generate a JSON file with the structure of AI models using `generate.py` 
+- Download all models from a JSON list using one script `download.py`. Next, using qbittorrent, you can generate torrent files.
+
+## Usage
+### Generate a JSON file with the structure of AI models
+
+1. Run the `generate.py` script with the `--user` and `--filter` arguments to generate a JSON file with the structure of AI models:
+
+```bash
+python generate.py --user TheBloke --filter GPTQ
+```
+
+This will create a JSON file containing all AI models created by the user "TheBloke" that contain the word "GPTQ" in their name. This is really useful to create a torrent mirror of Hugging Face.
+
+### Download models 
+
+2. Run the `download.py` script with the `--output_folder` and `--models_file` arguments to download the models:
+
+```bash
+python download.py --output_folder /media/user/models/ --models_file ./models.json 
+```
+
+This will download all models listed in the `models.json` file into the specified output folder.
+
+## Torrent Files 
+
+Torrent files can be found in the `torrents` directory within the `torrents` branch. You can switch to this branch using the following command:
+
+```bash
+git checkout torrents
+```
+
+TODO: Create a script that will generate a torrent file after downloading a model.
+
+## Contributing
+
+LlamaTor is a community-driven project. We value your contributions. If you have any suggestions for improvements, find any bugs, or want to contribute in any other way, please feel free to make a pull request or open an issue.
+
+### How You Can Help
+
+1. **Seed Torrents:** After downloading a model, keep your torrent client open so that others can download from you. The more seeders, the faster the download speed for everyone.
+
+2. **Add or Build Your Own Seedbox:** If you have a seedbox, consider adding it to the network to increase download speeds and reliability.
+
+3. **Donate:** Keeping seedboxes online and renting more storage costs money. Any donations to support this project are greatly appreciated.
+
+## License
+
+LlamaTor is licensed under the GNU General Public License v3.0. For more details, see the [LICENSE](LICENSE) file.