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 meaningful READMEs #81

Open

4 tasks

blootsvoets opened this issue Sep 26, 2019 · 0 comments

Labels

documentation high-priority

Milestone

Member

blootsvoets commented Sep 26, 2019 •

edited

Loading

The project code is now only usable by the original developers. Meaningful README's should be added to the root and to each of the modules.

Root README on purpose, outline of the project, general uses and general guidelines
Connector README with documentation on how to configure the connector and to implement a converter
Backend README with configuration options and a link to the API documentation
Frontend README with configuration options, developer use and production use.

Eventually, publishing information might also be added.

blootsvoets modified the milestones: v0.2.0, v0.3.0

blootsvoets added high-priority documentation labels

blootsvoets mentioned this issue

Add documentation #104

Merged

nivemaham modified the milestones: v0.3.0, v0.4.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment