diff --git a/README.md b/README.md index 2e2922b1e..ff4e38d97 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,31 @@ # Haruhi-DL +![build status](https://img.shields.io/gitlab/pipeline/laudom/haruhi-dl/master?gitlab_url=https%3A%2F%2Fgit.sakamoto.pl) + This is a fork of [youtube-dl](https://yt-dl.org/), focused on bringing a fast, steady stream of updates. We'll do our best to merge patches to any site, not only youtube. -If you want to contribute, send us a diff to [contribute@haruhi.download](mailto:contribute@haruhi.download) \ No newline at end of file +## Installing + +haruhi-dl is available on PyPI: [![version on PyPI](https://img.shields.io/pypi/v/haruhi-dl.svg)](https://pypi.org/project/haruhi-dl/) + +Install release from PyPI on Python 3.x: +```sh +$ python3 -m pip install --upgrade haruhi-dl +``` +Install from master (unstable) on Python 3.x: +```sh +$ python3 -m pip install --upgrade git+https://git.sakamoto.pl/laudom/haruhi-dl.git +``` + +Install release from PyPI on Python 2.x: +```sh +$ python2 -m pip install --upgrade haruhi-dl +``` +Install from master (unstable) on Python 2.x: +```sh +$ python2 -m pip install --upgrade git+https://git.sakamoto.pl/laudom/haruhi-dl.git +``` + +## Contributing + +If you want to contribute, send us a diff to .