From c6df2eddd6748f697795b8fa596b83f6e65b9c29 Mon Sep 17 00:00:00 2001 From: baarayy Date: Fri, 17 May 2024 13:53:19 +0300 Subject: [PATCH] update README.md --- Readme.md | 41 +++++++++++------------------------------ 1 file changed, 11 insertions(+), 30 deletions(-) diff --git a/Readme.md b/Readme.md index 69a0ced..1c00b28 100644 --- a/Readme.md +++ b/Readme.md @@ -1,40 +1,21 @@ ![MagnetFlow Logo](https://i.ibb.co/JnGbN6H/Untitled-design.jpg) -designed to streamline your torrent downloading experience. With MagnetFlow, you can easily search for and download torrents, manage your downloads, and enjoy high-speed peer-to-peer file sharing. +A simple BitTorrent client made as a side project for educational purposes. ## Installation -To get started with MagnetFlow, follow these simple steps: +### Clone the Repository -1. **Download:** Download the latest version of MagnetFlow from the [releases page](https://github.com/yourusername/MagnetFlow/releases). -2. **Install:** Follow the installation instructions for your operating system to install MagnetFlow on your device. -3. **Launch:** Once installed, launch MagnetFlow and start exploring its features. +```bash -## Usage - -Using MagnetFlow is straightforward: - -1. **Search:** Enter keywords or paste Magnet links to search for torrents. -2. **Download:** Select the desired torrents from the search results and initiate the download process. -3. **Manage:** Monitor the progress of your downloads, pause/resume them, and adjust download settings as needed. -4. **Play:** Preview media files using the built-in media player while they're downloading, or access downloaded files once they're complete. +clone: git clone git@github.com:baarayy/MagnetFlow.git +change directory: cd MagnetFlow +build binary: go build +run the client: ./magnetflow fileName.torrent +outputFileName +``` ## Contributing -We welcome contributions from the community to help improve MagnetFlow. If you'd like to contribute, please fork the repository, make your changes, and submit a pull request. Be sure to follow our [contribution guidelines](CONTRIBUTING.md). - -## Support - -If you encounter any issues or have any questions about MagnetFlow, please [open an issue](https://github.com/yourusername/MagnetFlow/issues) on GitHub. Our team will be happy to assist you. - -## License - -MagnetFlow is released under the [MIT License](LICENSE). Feel free to use, modify, and distribute it according to the terms of the license. - -## Acknowledgements - -MagnetFlow is built upon open-source technologies and libraries. We would like to thank the developers of these projects for their contributions to the community. - ---- - -Start downloading torrents seamlessly with MagnetFlow today! Happy torrenting! 🚀 +If you encounter any issues or have any recommended enhancement about MagnetFlow, +feel free to fork the repository and make your own changes, or [simply open an issue](https://github.com/baarayy/MagnetFlow/issues).