Add configuration guide to readme

suisei-cn / pystargazer

A flexible vtuber tracker.

MIT License

31 stars 1 forks source link

Add configuration guide to readme #4

Open PhotonQuantum opened 4 years ago

PhotonQuantum commented 4 years ago

Current configuration guide in readme is obsolete, and it should be updated to contain the following aspects:

how to install the main application (pip installation after I upload the package to pypi)
how to configure the application (environment variables and tokens.json)
guides on installing plugins (as is discussed in #2)
usage of builtin plugins (how to add new vtubers by restful-like api, subscribe to events by ws, and connect to mongodb)
plugin API

PhotonQuantum commented 4 years ago

Considering that this framework is likely to be deprecated in favor of a distributed one, and currently I don't have much time that can be spared to this project, I may not be able to finish writing the document in the foreseeable future. However, PRs on documentation are still welcomed if you are willing to contribute to this project.