newpipe-documentation/docs/index.md

18 lines
1.3 KiB
Markdown
Raw Normal View History

2018-09-15 19:01:28 +00:00
# Welcome to the NewPipe Documentation.
2018-02-20 22:06:55 +00:00
2018-11-16 18:23:01 +00:00
<img width=150 src="https://raw.githubusercontent.com/TeamNewPipe/NewPipe/dev/assets/new_pipe_icon_5.png"/>
2019-02-21 14:56:28 +00:00
This site is/should be a beginner friendly tutorial and documentation for people who want to use, or write services for the [NewPipe Extractor](https://github.com/TeamNewPipe/NewPipeExtractor) however it does also contain several notes about how to maintain NewPipe.
2018-09-01 13:47:57 +00:00
It is an addition to our auto generated [jdoc documentation](https://teamnewpipe.github.io/NewPipeExtractor/javadoc/).
2018-02-20 22:06:55 +00:00
2018-09-01 13:47:57 +00:00
Please be aware that it is also in an early state, so help and [feedback](https://github.com/TeamNewPipe/documentation/issues) is always welcome :D
2018-02-20 22:06:55 +00:00
2018-05-05 21:49:33 +00:00
## Introduction
2019-02-21 14:56:28 +00:00
The NewPipeExtractor is a Java framework for scraping video platform websites in a way that they can be accessed like a normal API. The extractor is the core of the popular YouTube and streaming App [NewPipe](https://newpipe.schabi.org) for android, however it's system independent and also available for other platforms as well.
2018-05-05 21:49:33 +00:00
The beauty behind this framework is it takes care of the extracting process, error handling etc., so you can take care about what is important: Scraping the website.
It focuses on making it possible for the creator of a scraper for a streaming service to create the best outcome with the least amount of written code.