Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add configuration guide to readme #4

Open
PhotonQuantum opened this issue Apr 23, 2020 · 2 comments
Open

Add configuration guide to readme #4

PhotonQuantum opened this issue Apr 23, 2020 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@PhotonQuantum
Copy link
Member

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 Better plugin discovery #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 PhotonQuantum added the documentation Improvements or additions to documentation label Apr 23, 2020
@PhotonQuantum
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@PhotonQuantum and others