Skip to content

Commit

Permalink
added readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DatL4g committed Dec 5, 2023
1 parent 2eb5a26 commit 061d540
Showing 1 changed file with 100 additions and 0 deletions.
100 changes: 100 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
# Burning-Series

[![Issues](https://img.shields.io/github/issues/DATL4G/Burning-Series.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/issues)
[![Stars](https://img.shields.io/github/stars/DATL4G/Burning-Series.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/stargazers)
[![Forks](https://img.shields.io/github/forks/DATL4G/Burning-Series.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/network/members)
[![Contributors](https://img.shields.io/github/contributors/DATL4G/Burning-Series.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/graphs/contributors)
[![License](https://img.shields.io/github/license/DATL4G/Burning-Series.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/blob/master/LICENSE)
[![Github all releases](https://img.shields.io/github/downloads/DATL4G/Burning-Series/total.svg?style=for-the-badge)](https://github.com/DATL4G/Burning-Series/releases)

[![Release Status](https://github.com/DatL4g/Burning-Series/actions/workflows/release.yml/badge.svg)](https://github.com/DATL4G/Burning-Series/actions/workflows/release.yml)

![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)
![Kotlin](https://img.shields.io/badge/kotlin-%230095D5.svg?style=for-the-badge&logo=kotlin&logoColor=white)
![Android Studio](https://img.shields.io/badge/Android%20Studio-3DDC84.svg?style=for-the-badge&logo=android-studio&logoColor=white)
![IntelliJ IDEA](https://img.shields.io/badge/IntelliJIDEA-000000.svg?style=for-the-badge&logo=intellij-idea&logoColor=white)
![SQLite](https://img.shields.io/badge/sqlite-%2307405e.svg?style=for-the-badge&logo=sqlite&logoColor=white)

Watch any series or videos on [Burning Series](https://bs.to/) easily with this app.
You can see the latest series and episodes, get an overview of all available series, save your favorites and start watching directly inside the app.
**You can't log in to your [Burning Series](https://bs.to/) Account because it's not using an official API.** Read the [Important Notice](#important-notice) for more info.

- [Important Notice](#important-notice)
- [Supported devices and Installation](#supported-devices-and-installation)
- [Contributing](#contributing)
- [Maintainers](#maintainers)
- [Support the project](#support-the-project)

## Important Notice

This app is **NOT OFFICIAL** by [Burning Series](https://bs.to/)!!!

This is a personal project and doesn't rely on any official API by [Burning Series](https://bs.to/), that means it could break any time.
It's not guaranteed that this project will be maintained, especially not by any owner or developer of [Burning Series](https://bs.to/).
If the app stops working don't report that in any form on [Burning Series](https://bs.to/), instead open an [Issue](https://github.com/DATL4G/BurningSeries-Android/issues/new/choose) or fix it yourself and create a pull request here.

**This project is not related to any owner, developer or other staff from [Burning Series](https://bs.to/)**

**Furthermore, this project is for personal and educational purposes only**

## Supported devices and Installation

All Android smartphones with version >=8.0 (Oreo and up) are supported, furthermore Android TVs should work as well.

To install the app head over to the [Release Section](https://github.com/DATL4G/Burning-Series/releases) and download the ```.apk``` file. For more advanced users is an ```.aab``` file provided which can be installed using [bundletool](https://developer.android.com/studio/command-line/bundletool).
Installing the ```.apk``` file is easy, just copy it to your phone (or download it directly on your phone) and open it to install. If this won't work you can use [ADB](https://developer.android.com/studio/command-line/adb) sideloading to install it from your pc on your phone.

Search on the internet if you face any problems. Don't ask for help here!

### Desktop

- **Windows**
- **MacOS**
- **Linux**
- Fedora
- AppImage
- Debian / Ubuntu
- Tarball

### Browser (Activation Extension)

If you can't access [bs.to](https://bs.to) you have to enable DoH (DNS over HTTPS).
Setting this up may differ depending on your browser, however I suggest to use **Cloudflare** as provider.

The extension doesn't need to be updated every version, it just follows the overall versioning scheme.
If an update is required/recommended, then there is a hint in the [release notes](https://github.com/DATL4G/Burning-Series/releases/latest).

- **Chromium**
- Chrome
- Brave
- Opera
- Edge
- etc...
- **Firefox**
- may require to allow some website permissions manually

## Contributing

When you face any bugs or problems please open an [Issue](https://github.com/DATL4G/Burning-Series/issues/new/choose).

To add functionality fork the project and create a pull request afterwards. You should know how that works if you are a developer :)
You can add yourself to the list below if you want then.

### Maintainers

| Avatar | Contributor |
|---|:---:|
| [![](https://avatars3.githubusercontent.com/u/46448715?s=50&v=4)](http://github.com/DatL4g) | [DatLag](http://github.com/DatL4g) |

## Support the project

[![Github-sponsors](https://img.shields.io/badge/sponsor-30363D?style=for-the-badge&logo=GitHub-Sponsors&logoColor=#EA4AAA)](https://github.com/sponsors/DATL4G)
[![PayPal](https://img.shields.io/badge/PayPal-00457C?style=for-the-badge&logo=paypal&logoColor=white)](https://paypal.me/datlag)

### This is a non-profit project!

Sponsoring to this project means sponsoring to all my projects!
So the further text is not to be attributed to this project, but to all my apps and libraries.

Supporting this project helps to keep it up-to-date. You can donate if you want or contribute to the project as well.
This shows that the app or library is used by people, and it's worth to maintain.

0 comments on commit 061d540

Please sign in to comment.