README.md 1.47 KB
Newer Older
Cyril Müller's avatar
Cyril Müller committed
1
2
# NewPipe Extractor

3
[![Build Status](https://travis-ci.org/TeamNewPipe/NewPipeExtractor.svg?branch=master)](https://travis-ci.org/TeamNewPipe/NewPipeExtractor) [![JIT Pack Badge](https://jitpack.io/v/TeamNewPipe/NewPipeExtractor.svg)](https://jitpack.io/#TeamNewPipe/NewPipeExtractor) [Documentation](https://teamnewpipe.github.io/documentation/)
Christian Schabesberger's avatar
Christian Schabesberger committed
4

5
NewPipe Extractor is a library for extracting things from streaming sites. It is a core component of [NewPipe](https://github.com/TeamNewPipe/NewPipe), but could be used independently.
Mauricio Colli's avatar
Mauricio Colli committed
6

7
## Usage
Christian Schabesberger's avatar
Christian Schabesberger committed
8

9
NewPipe Extractor is available at JitPack's Maven repo.
10

11
If you're using Gradle, you could add NewPipe Extractor as a dependency with the following steps:
12

13
1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`.
Cyril Müller's avatar
Cyril Müller committed
14
2. Add `compile 'com.github.TeamNewPipe:NewPipeExtractor:v0.11.0'`the `dependencies` in your `build.gradle`. Replace `v0.11.0` with the latest release.
15

16
## Supported sites
17

18
19
20
21
The following sites are currently supported:

- YouTube
- SoundCloud
22
23

## License
24

25
26
27
28
29
30
31
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)  

NewPipe is Free Software: You can use, study share and improve it at your
will. Specifically you can redistribute and/or modify it under the terms of the
[GNU General Public License](https://www.gnu.org/licenses/gpl.html) as
published by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.