Finish readme
This commit is contained in:
parent
7bd447e398
commit
77541200a4
20
readme.md
20
readme.md
@ -1,3 +1,23 @@
|
||||
# AniCal
|
||||
|
||||
Generate ical from your Anilist data for upcoming anime releases that are in your planning, watching (sequel) (optional) and in progress lists.
|
||||
|
||||
## Usage
|
||||
|
||||
1. Git pull the repo
|
||||
2. Run `python main.py`
|
||||
3. The `anime.ics` file will be created in the repo root
|
||||
4. Import the `.ics` file into your calendar app of choice
|
||||
|
||||
## Configuration
|
||||
|
||||
The `config.toml` file is where you can configure the lists to pull from and the ical name.
|
||||
|
||||
```toml
|
||||
[anilist]
|
||||
userId = 8283179 # your Anilist user id
|
||||
mediaType = "ANIME" # this is the media type you want to pull from, just leave it as is
|
||||
|
||||
[anical]
|
||||
listNames = ["Completed", "Planning", "Watching", "Rewatching", "Paused"] # these can be any of the lists in your Anilist account including custom
|
||||
```
|
||||
|
||||
Loading…
Reference in New Issue
Block a user