Skip to content
This repository has been archived by the owner on Sep 11, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
:(
  • Loading branch information
Redone lkabuci authored Sep 11, 2024
1 parent a75cbd5 commit 08c86b3
Showing 1 changed file with 18 additions and 5 deletions.
23 changes: 18 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
<div align="center" style="background-color: #ffcccc; border: 2px solid #ff0000; padding: 15px; margin: 20px 0; border-radius: 5px;">
<h2 style="color: #ff0000; text-align: center; margin-top: 0;">⚠️ REPOSITORY ARCHIVED ⚠️</h2>
<p style="font-size: 16px; text-align: center;">
This repository is no longer actively maintained.<br>
It has been archived for historical reference.<br>
Thank you to all contributors and users of this project.<br>
Last updated: Oct 21, 2023
</p>
<hr style="border-top: 1px solid #ff0000; margin: 15px 0;">
<p></p>
</div>


<p align="center">

<img src="https://github.com/kaboussi/Botflix/assets/65725801/a0f2db38-fe3c-48af-b63c-30b6aabcd288" />
Expand All @@ -13,7 +26,7 @@
</a>
</div>

Botflix is a Python scrapping CLI that combine [scrapy](https://scrapy.org) and [webtorrent](https://github.com/webtorrent/webtorrent-cli) in one command for streaming movies from your terminal.
Botflix is a Python scrapping CLI that combines [scrapy](https://scrapy.org) and [webtorrent](https://github.com/webtorrent/webtorrent-cli) in one command for streaming movies from your terminal.

## Installation:
#### For ArchLinux or Arch-based distro:
Expand All @@ -25,9 +38,9 @@ To run
```bash
botflix
```
`botflix` is the replacement for the command prefix `python3 main.py` in this readme. for example `python3 main.py config "vlc"` will be `botflix config "vlc"`, which is the final step after installation.
`botflix` is the replacement for the command prefix `python3 main.py` in this readme. for example `python3 main.py config "vlc"` will be `botflix config "vlc"`, the final step after installation.
#### For others
> Botflix is written in python, and it depends on [webtorrent](https://github.com/webtorrent/webtorrent-cli), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.com)
> Botflix is written in Python, and it depends on [webtorrent](https://github.com/webtorrent/webtorrent-cli), [NodeJS](https://nodejs.org) and [npm](https://www.npmjs.com)
1. install NodeJS on your machine ([read mode](https://nodejs.org/en/download/)).
```bash
Expand Down Expand Up @@ -73,7 +86,7 @@ pip install -r requirements.txt
## Usage:
* First you need to set up a default player.
> Note that only [vlc](https://www.videolan.org/vlc/) and [mpv](https://mpv.io/) are supported. <br>
> If you are a Windows user make sure that you add your player to the PATH. [read more](https://www.vlchelp.com/add-vlc-command-prompt-windows/)
> If you are a Windows user, make sure you add your player to the PATH. [read more](https://www.vlchelp.com/add-vlc-command-prompt-windows/)
```bash
python3 main.py config "vlc"
```
Expand All @@ -95,7 +108,7 @@ What movie are you looking for? red notice
* To start watching you can just type the number of the movie in the table.

## Contributing:
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

Expand Down

0 comments on commit 08c86b3

Please sign in to comment.