Change: update readme

README.md

@@ -2,17 +2,8 @@
   <p>
     <a href="#"><img src="https://assets.nickficano.com/gh-pytube.min.svg" width="456" height="143" alt="pytube logo" /></a>
   </p>
-  <p align="center">
-	<a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/dm/pytube?style=flat-square" alt="pypi"/></a>
-	<a href="https://pytube.io/en/latest/"><img src="https://readthedocs.org/projects/python-pytube/badge/?version=latest&style=flat-square" /></a>
-	<a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/v/pytube?style=flat-square" /></a>
-  </p>
 </div>
 
-### Actively soliciting contributors!
-
-Have ideas for how pytube can be improved? Feel free to open an issue or a pull request!
-
 # pytube
 
 *pytube* is a genuine, lightweight, dependency-free Python library (and command-line utility) for downloading YouTube videos.
@@ -21,17 +12,6 @@ Have ideas for how pytube can be improved? Feel free to open an issue or a pull
 
 Detailed documentation about the usage of the library can be found at [pytube.io](https://pytube.io). This is recommended for most cases. If you want to hastily download a single video, the [quick start](#Quickstart) guide below might be what you're looking for.
 
-## Description
-
-YouTube is the most popular video-sharing platform in the world and as a hacker, you may encounter a situation where you want to script something to download videos. For this, I present to you: *pytube*.
-
-*pytube* is a lightweight library written in Python. It has no third-party
-dependencies and aims to be highly reliable.
-
-*pytube* also makes pipelining easy, allowing you to specify callback functions for different download events, such as  ``on progress`` or ``on complete``.
-
-Furthermore, *pytube* includes a command-line utility, allowing you to download videos right from the terminal.
-
 ## Features
 
 - Support for both progressive & DASH streams
@@ -43,6 +23,8 @@ Furthermore, *pytube* includes a command-line utility, allowing you to download
 - Ability to capture thumbnail URL
 - Extensively documented source code
 - No third-party dependencies
+- Proxy support
+- Suport for bulk downloading channel videos
 
 ## Quickstart
 
@@ -52,42 +34,49 @@ This guide covers the most basic usage of the library. For more detailed informa
 
 Pytube requires an installation of Python 3.6 or greater, as well as pip. (Pip is typically bundled with Python [installations](https://python.org/downloads).)
 
-To install from PyPI with pip:
+To install using github:
 
 ```bash
-$ python -m pip install pytube
+$ python -m pip install git+https://github.com/javad-rzvn/pytube
 ```
 
-Sometimes, the PyPI release becomes slightly outdated. To install from the source with pip:
+## Usage
 
-```bash
-$ python -m pip install git+https://github.com/pytube/pytube
+If you have internet problem, you should use proxy. To do that, you better setup a ``v2ray`` connection, then use its proxy to download videos.
+
+### Download single video from youtube channel
+
+```python
+from pytube import YouTube
+from pytube.cli import on_progress
+
+YouTube("https://youtu.be/2lAe1cqCOXo").streams.first().download()
+proxies = {"http": "socks5://127.0.0.1:2080"}
+yt = YouTube(
+    "http://youtube.com/watch?v=2lAe1cqCOXo",
+    on_progress_callback=on_progress,
+    # on_complete_callback=complete_func,
+    proxies=proxies,
+)
+yt.streams.filter(progressive=True, file_extension="mp4").order_by(
+    "resolution"
+).desc().first().download()
 ```
 
-### Using pytube in a Python script
+### Download all channel's videos
 
-To download a video using the library in a script, you'll need to import the YouTube class from the library and pass an argument of the video URL. From there, you can access the streams and download them.
+In the example below, it downloads only 3 videos of the channel.
 
 ```python
- >>> from pytube import YouTube
- >>> YouTube('https://youtu.be/2lAe1cqCOXo').streams.first().download()
- >>> yt = YouTube('http://youtube.com/watch?v=2lAe1cqCOXo')
- >>> yt.streams
-  ... .filter(progressive=True, file_extension='mp4')
-  ... .order_by('resolution')
-  ... .desc()
-  ... .first()
-  ... .download()
-```
+from pytube import Channel
 
-### Using the command-line interface
+proxies = {"http": "socks5://127.0.0.1:2080"}
+c = Channel('https://www.youtube.com/c/FalcomMusicChannel/videos', proxies=proxies)
 
-Using the CLI is remarkably straightforward as well. To download a video at the highest progressive quality, you can use the following command:
-```bash
-$ pytube https://youtube.com/watch?v=2lAe1cqCOXo
-```
+print(f'Downloading videos by: {c.channel_name}')
+print(f'Channel URLs: {c.video_urls[:3]}')
 
-You can also do the same for a playlist:
-```bash
-$ pytube https://www.youtube.com/playlist?list=PLS1QulWo1RIaJECMeUT4LFwJ-ghgoSH6n
+for i, video in enumerate(c.videos[:3]):
+    print(c.video_urls[i])
+    video.streams.first().download()
 ```