Jen-Chieh Shen commited on
Commit
d0ef488
·
unverified ·
1 Parent(s): 8d0aaa4

Link corresponding website to all badges (#960)

Browse files

* Organize headers in README

* Link badges to relevant pages

Files changed (1) hide show
  1. README.md +14 -12
README.md CHANGED
@@ -1,36 +1,34 @@
1
  <div align="center">
2
  <p>
3
- <img src="https://assets.nickficano.com/gh-pytube.min.svg" width="456" height="143" alt="pytube logo" />
4
  </p>
5
  <p align="center">
6
- <img src="https://img.shields.io/pypi/dm/pytube?style=flat-square" alt="pypi"/>
7
- <img src="https://readthedocs.org/projects/python-pytube/badge/?version=latest&style=flat-square" />
8
- <a href="https://codecov.io/gh/pytube/pytube" aria-label="coverage">
9
- <img src="https://img.shields.io/codecov/c/github/pytube/pytube?style=flat-square" />
10
- </a>
11
- <img src="https://img.shields.io/pypi/v/pytube?style=flat-square" />
12
  </p>
13
  </div>
14
 
15
-
16
-
17
  ### Actively soliciting contributers!
 
18
  Have ideas for how pytube can be improved? Feel free to open an issue or a pull
19
  request!
20
 
21
  # pytube
 
22
  *pytube* is a very serious, lightweight, dependency-free Python library (and
23
  command-line utility) for downloading YouTube Videos.
24
 
25
-
26
  ## Documentation
 
27
  Detailed documentation about how to use the library can be found on our
28
  [readthedocs](https://python-pytube.readthedocs.io) page. This is recommended
29
  for most use cases. If you just want to quickly download a single video,
30
  the [quickstart](#Quickstart) guide below might be what you're looking for.
31
 
32
-
33
  ## Description
 
34
  YouTube is the most popular video-sharing platform in the world and as a hacker
35
  you may encounter a situation where you want to script something to download
36
  videos. For this I present to you *pytube*.
@@ -44,8 +42,8 @@ for different download events, such as ``on progress`` or ``on complete``.
44
  Finally *pytube* also includes a command-line utility, allowing you to quickly
45
  download videos right from terminal.
46
 
47
-
48
  ## Features
 
49
  - Support for both progressive & DASH streams
50
  - Support for downloading complete playlist
51
  - Easily register ``on_download_progress`` & ``on_download_complete`` callbacks
@@ -57,11 +55,13 @@ download videos right from terminal.
57
  - No third-party dependencies
58
 
59
  ## Quickstart
 
60
  This guide is only meant to cover the most basic usage of the library. For more
61
  detailed information, please refer to our
62
  [readthedocs](https://python-pytube.readthedocs.io) page.
63
 
64
  ### Installation
 
65
  Pytube requires an installation of python 3.6 or greater, as well as pip.
66
  Pip is typically bundled with python installations, and you can find options
67
  for how to install python at https://python.org.
@@ -80,6 +80,7 @@ $ python -m pip install git+https://github.com/pytube/pytube
80
  ```
81
 
82
  ### Using pytube in a python script
 
83
  To download a video using the library in a script, you'll need to first import
84
  the YouTube class from the library, and pass it an argument of the video url.
85
  From there, you can access the streams and download them.
@@ -97,6 +98,7 @@ From there, you can access the streams and download them.
97
  ```
98
 
99
  ### Using the command-line interface
 
100
  Using the CLI is extremely straightforward as well. To download a video at the
101
  highest progressive quality, you can use the following command:
102
  ```bash
 
1
  <div align="center">
2
  <p>
3
+ <a href="#"><img src="https://assets.nickficano.com/gh-pytube.min.svg" width="456" height="143" alt="pytube logo" /></a>
4
  </p>
5
  <p align="center">
6
+ <a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/dm/pytube?style=flat-square" alt="pypi"/></a>
7
+ <a href="https://python-pytube.readthedocs.io/en/latest/"><img src="https://readthedocs.org/projects/python-pytube/badge/?version=latest&style=flat-square" /></a>
8
+ <a href="https://codecov.io/gh/pytube/pytube" aria-label="coverage"><img src="https://img.shields.io/codecov/c/github/pytube/pytube?style=flat-square" /></a>
9
+ <a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/v/pytube?style=flat-square" /></a>
 
 
10
  </p>
11
  </div>
12
 
 
 
13
  ### Actively soliciting contributers!
14
+
15
  Have ideas for how pytube can be improved? Feel free to open an issue or a pull
16
  request!
17
 
18
  # pytube
19
+
20
  *pytube* is a very serious, lightweight, dependency-free Python library (and
21
  command-line utility) for downloading YouTube Videos.
22
 
 
23
  ## Documentation
24
+
25
  Detailed documentation about how to use the library can be found on our
26
  [readthedocs](https://python-pytube.readthedocs.io) page. This is recommended
27
  for most use cases. If you just want to quickly download a single video,
28
  the [quickstart](#Quickstart) guide below might be what you're looking for.
29
 
 
30
  ## Description
31
+
32
  YouTube is the most popular video-sharing platform in the world and as a hacker
33
  you may encounter a situation where you want to script something to download
34
  videos. For this I present to you *pytube*.
 
42
  Finally *pytube* also includes a command-line utility, allowing you to quickly
43
  download videos right from terminal.
44
 
 
45
  ## Features
46
+
47
  - Support for both progressive & DASH streams
48
  - Support for downloading complete playlist
49
  - Easily register ``on_download_progress`` & ``on_download_complete`` callbacks
 
55
  - No third-party dependencies
56
 
57
  ## Quickstart
58
+
59
  This guide is only meant to cover the most basic usage of the library. For more
60
  detailed information, please refer to our
61
  [readthedocs](https://python-pytube.readthedocs.io) page.
62
 
63
  ### Installation
64
+
65
  Pytube requires an installation of python 3.6 or greater, as well as pip.
66
  Pip is typically bundled with python installations, and you can find options
67
  for how to install python at https://python.org.
 
80
  ```
81
 
82
  ### Using pytube in a python script
83
+
84
  To download a video using the library in a script, you'll need to first import
85
  the YouTube class from the library, and pass it an argument of the video url.
86
  From there, you can access the streams and download them.
 
98
  ```
99
 
100
  ### Using the command-line interface
101
+
102
  Using the CLI is extremely straightforward as well. To download a video at the
103
  highest progressive quality, you can use the following command:
104
  ```bash