mirror of
https://github.com/Benexl/FastAnime.git
synced 2026-02-04 11:07:48 -08:00
docs: update reamde
This commit is contained in:
26
README.md
26
README.md
@@ -51,7 +51,6 @@ Heavily inspired by [animdl](https://github.com/justfoolingaround/animdl), [magi
|
||||
- [Key Bindings](#key-bindings)
|
||||
- [Script Messages](#script-messages)
|
||||
- [Configuration](#configuration)
|
||||
- [The python api](#the-python-api)
|
||||
- [Contributing](#contributing)
|
||||
- [Receiving Support](#receiving-support)
|
||||
- [Supporting the Project](#supporting-the-project)
|
||||
@@ -59,7 +58,7 @@ Heavily inspired by [animdl](https://github.com/justfoolingaround/animdl), [magi
|
||||
|
||||
> [!IMPORTANT]
|
||||
>
|
||||
> This project currently scrapes allanime and animepahe. The site is in the public domain and can be accessed by any one with a browser.
|
||||
> This project currently scrapes allanime, aniwatch and animepahe. The site is in the public domain and can be accessed by any one with a browser.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -234,6 +233,7 @@ Available options for the fastanime include:
|
||||
- `--use-mpv-mod/--use-default-player` whether to use python-mpv
|
||||
- `--provider <allanime/animepahe>` anime site of choice to scrape from
|
||||
- `--sync-play` or `-sp` use syncplay for streaming anime so you can watch with your friends
|
||||
- `--sub_lang <en/or any other common shortform for country>` regex is used to determine the appropriate. Only works when provider is aniwatch.
|
||||
|
||||
Example usage of the above options
|
||||
|
||||
@@ -654,28 +654,6 @@ notification_duration=2
|
||||
# Not implemented yet
|
||||
```
|
||||
|
||||
## The python api
|
||||
|
||||
The project offers a python api that can be used in other python programs.
|
||||
|
||||
```python
|
||||
from fastanime.AnimeProvider import AnimeProvider
|
||||
|
||||
# all output is typed, so will be easy to work with
|
||||
|
||||
# providers include [allanime, animepahe]
|
||||
provider = AnimeProvider(provider="allanime")
|
||||
|
||||
# to search for anime
|
||||
provider.search_for_anime()
|
||||
|
||||
# to get anime info
|
||||
provider.get_anime()
|
||||
|
||||
# to get streams of an episode
|
||||
provider.get_episode_streams()
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
We welcome your issues and feature requests. However, due to time constraints, we currently do not plan to add another provider.
|
||||
|
||||
Reference in New Issue
Block a user