mirror of
https://github.com/movie-web/providers.git
synced 2025-09-13 18:03:26 +00:00
Write more documentation
This commit is contained in:
@@ -1,7 +1,14 @@
|
||||
# Introduction
|
||||
|
||||
- What is this project
|
||||
- How does it work?
|
||||
- What environments can it be ran in?
|
||||
## What is `@movie-web/providers`?
|
||||
|
||||
TODO
|
||||
`@movie-web/providers` is the soul of [movie-web.app](https://movie-web.app). It's a collection of scrapers of various streaming sites. It extracts the raw streams from those sites, so you can watch them without any extra fluff from the original sites.
|
||||
|
||||
## What can I use this on?
|
||||
|
||||
We support many different environments, here are a few examples:
|
||||
- In browser, watch streams without needing a server to scrape (does need a proxy)
|
||||
- In a native app, scrape in the app itself
|
||||
- In a backend server, scrape on the server and give the streams to the client to watch.
|
||||
|
||||
To find out how to configure the library for your environment, You can read [How to use on X](../2.Essentials/0.usage-on-x.md).
|
||||
|
@@ -1,5 +1,5 @@
|
||||
# Examples
|
||||
|
||||
- list a few examples, just link to github folders
|
||||
|
||||
TODO
|
||||
::alert{type="warning"}
|
||||
There are no examples yet, stay tuned!
|
||||
::
|
||||
|
Reference in New Issue
Block a user