From 4866f49d13cfaa2b534d642ecba8fcc10dad8ff6 Mon Sep 17 00:00:00 2001 From: John O'Keefe Date: Mon, 9 Sep 2024 19:37:34 -0400 Subject: [PATCH] updated README.md with instructions --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d570f74..88badbe 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,35 @@ ## About -Track anime shows by syncing with various services. Anilist, MyAnimeList, Kitsu, Simkl... +Track the anime you are watching by syncing with various services. Anilist, MyAnimeList, Simkl... This has been built with the official Wails Svelte-TS template. +To run as is, please feel free to download a binary from the releases page. + +If you are getting too many errors due to api usage, please build from source. + +## Build from Source + +### Get API Keys +First you will need your own API keys for the various services the app connects to. +AniList: [AniList Developer App](https://anilist.co/settings/developer) +MyAnimeList: [MyAnimeList Developer App](https://myanimelist.net/apiconfig/create) +Simkl: [Simkl Developer](https://simkl.com/settings/developer/) + + - Name: AniTrack + - Redirect URL: http://localhost:6734/callback + - App Type: web + - Homepage URL: http://localhost or the Github URL + - Company Name: AniTrack + - Commercial/Non-Commercial: non-commercial + - Purpose of Use: hobbyist + +Once you have the IDs, Keys, and Secrets create an environment.go file based on the environment.go.example and fill in the fields. + +### Install Wails and Dependencies +Please follow the instructions [here](https://wails.io/docs/gettingstarted/installation) to get Wails up and running and follow the instructions below. + ## Live Development To run in live development mode, run `wails dev` in the project directory. This will run a Vite development @@ -15,4 +40,4 @@ to this in your browser, and you can call your Go code from devtools. ## Building -To build a redistributable, production mode package, use `wails build`. +To build a redistributable, production mode package, use `wails build --clean`.