74 lines
3.1 KiB
Markdown
74 lines
3.1 KiB
Markdown
[![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]
|
|
|
|
<!-- PROJECT LOGO -->
|
|
<br />
|
|
<p align="center">
|
|
<a href="https://github.com/distribyted/distribyted">
|
|
<img src="docs/images/distribyted_icon.png" alt="Logo" width="100">
|
|
</a>
|
|
|
|
<h3 align="center">distribyted</h3>
|
|
|
|
<p align="center">
|
|
Torrent client with on-demand file downloading as a filesystem.
|
|
<br />
|
|
<br />
|
|
<a href="https://github.com/distribyted/distribyted/issues">Report a Bug</a>
|
|
·
|
|
<a href="https://github.com/distribyted/distribyted/issues">Request Feature</a>
|
|
</p>
|
|
</p>
|
|
|
|
<!-- TABLE OF CONTENTS -->
|
|
## Table of Contents
|
|
|
|
* [About the Project](#about-the-project)
|
|
* [Contributing](#contributing)
|
|
* [License](#license)
|
|
|
|
<!-- ABOUT THE PROJECT -->
|
|
## 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.
|
|
|
|
<!-- MARKDOWN LINKS & IMAGES -->
|
|
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
[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
|