Add README.md

This commit is contained in:
blank X 2020-10-25 15:05:36 +07:00
parent cd3630525e
commit c515153d70
1 changed files with 16 additions and 0 deletions

16
README.md Normal file
View File

@ -0,0 +1,16 @@
# RSS Anime Notifier but in Rust
Get anime schedule from https://anichart.net and gives an RSS feed to episodes that have already aired
### How to Build and Run
https://doc.rust-lang.org/stable/book/ch01-03-hello-cargo.html#building-and-running-a-cargo-project
### Environment Variables
`PORT` - Specify the port to listen to, default: 8080
### How to Use
1. Start the script, obviously
2. Get the Anilist anime ID
For example, if the URL is https://anilist.co/anime/112609/Majo-no-Tabitabi, the anime ID is 112609
3. Add http://127.0.0.1:[port]/[animeID] to your RSS reader
For example, if your port is 8080 and the anime ID is 112609, you'd use http://127.0.0.1:8080/112609