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

Update documentation / Usage examples #1

Open

4 tasks

St4NNi opened this issue Oct 6, 2022 · 0 comments

Member

St4NNi commented Oct 6, 2022

Missing documentation

This repo currently contains no / limited documentation. To properly change this the following steps need to be done:

Change Readme to include the proper paths (from API)
Add Docstring / Getting started section to README and lib.rs (for docs.rs)
Add proper License reference to Cargo.toml
Add link to documentation / this github repo to Cargo.toml

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