Skip to content

Commit 7beb90b

Browse files
authored
Merge pull request #34 from wb9688/readme
[WiP] Improve README
2 parents 7fffef5 + bcae90d commit 7beb90b

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
1-
NewPipe Extractor [![Build Status](https://travis-ci.org/TeamNewPipe/NewPipeExtractor.svg?branch=master)](https://travis-ci.org/TeamNewPipe/NewPipeExtractor)
2-
=================
1+
# NewPipe Extractor [![Build Status](https://travis-ci.org/TeamNewPipe/NewPipeExtractor.svg?branch=master)](https://travis-ci.org/TeamNewPipe/NewPipeExtractor)
32

3+
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.
44

5-
This is the system independent core of [NewPipe](https://github.com/TeamNewPipe/NewPipe).
6-
It can be used to create your own java based NewPipe client.
5+
## Usage
76

8-
A small example showing how to use the extractor can be found [here](https://github.com/TeamNewPipe/np-cli).
7+
NewPipe Extractor is available at JitPack's Maven repo.
98

10-
## Usage
11-
Using this Extractor in your own open source projects is simple. We offer this extractor as maven repository, so if you use
12-
gradle you can simple include NewPipeExtractor to your project by adding this line to the dependencies:
9+
If you're using Gradle, you could add NewPipe Extractor as a dependency with the following steps:
1310

14-
`compile 'com.github.TeamNewPipe:NewPipeExtractor:7ae274`
11+
1. Add `maven { url 'https://jitpack.io' }` to the `repositories` in your `build.gradle`.
12+
2. Add `compile 'com.github.TeamNewPipe:NewPipeExtractor:82ae72900a'`the `dependencies` in your `build.gradle`. Replace `82ae72900a` with the latest commit.
1513

16-
A fill documentation is no yet there, but it will follow :) Stay tuned.
14+
## Supported sites
1715

16+
The following sites are currently supported:
17+
18+
- YouTube
19+
- SoundCloud
1820

1921
## License
22+
2023
[![GNU GPLv3 Image](https://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl-3.0.en.html)
2124

2225
NewPipe is Free Software: You can use, study share and improve it at your

0 commit comments

Comments
 (0)