diff --git a/README.md b/README.md new file mode 100644 index 0000000..1d4fcd8 --- /dev/null +++ b/README.md @@ -0,0 +1,74 @@ +[![Contributors][contributors-shield]][contributors-url] +[![Forks][forks-shield]][forks-url] +[![Stargazers][stars-shield]][stars-url] +[![Issues][issues-shield]][issues-url] +[![GPL3 License][license-shield]][license-url] + + +
+

+ + Logo + + +

distribyted

+ +

+ Torrent client with on-demand file downloading as a filesystem. +
+
+ Report a Bug + ยท + Request Feature +

+

+ + +## Table of Contents + +* [About the Project](#about-the-project) +* [Contributing](#contributing) +* [License](#license) + + +## About The Project + +![Distribyted Screen Shot][product-screenshot] + +Distribyted tries to make easier integrations with other applications among torrent files, presenting them as a standard filesystem. + +We aim to use some compressed files characteristics to avoid download it entirely, just the parts that we'll need. + +Also, if the file format is not supported, distribyted can stream and seek through the file if needed. + +**Note that distribyted is in alpha version, it is a proof of concept with a lot of bugs.** + +## Contributing + +Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**. + +1. Fork the Project +2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`) +3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the Branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## License + +Distributed under the GPL3 license. See `LICENSE` for more information. + + + +[contributors-shield]: https://img.shields.io/github/contributors/distribyted/distribyted.svg?style=flat-square +[contributors-url]: https://github.com/distribyted/distribyted/graphs/contributors +[forks-shield]: https://img.shields.io/github/forks/distribyted/distribyted.svg?style=flat-square +[forks-url]: https://github.com/distribyted/distribyted/network/members +[stars-shield]: https://img.shields.io/github/stars/distribyted/distribyted.svg?style=flat-square +[stars-url]: https://github.com/distribyted/distribyted/stargazers +[issues-shield]: https://img.shields.io/github/issues/distribyted/distribyted.svg?style=flat-square +[issues-url]: https://github.com/distribyted/distribyted/issues +[license-shield]: https://img.shields.io/github/license/distribyted/distribyted.svg?style=flat-square +[license-url]: https://github.com/distribyted/distribyted/blob/master/LICENSE +[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555 +[linkedin-url]: https://linkedin.com/in/distribyted +[product-screenshot]: docs/images/routes_screenshot.png diff --git a/docs/images/distribyted_icon.png b/docs/images/distribyted_icon.png new file mode 100644 index 0000000..cbdebf3 Binary files /dev/null and b/docs/images/distribyted_icon.png differ diff --git a/docs/images/routes_screenshot.png b/docs/images/routes_screenshot.png new file mode 100644 index 0000000..05787ae Binary files /dev/null and b/docs/images/routes_screenshot.png differ