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.

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

Flesh out the readme #12

Open
lemonsaurus opened this issue Apr 1, 2021 · 3 comments
Open

Flesh out the readme #12

lemonsaurus opened this issue Apr 1, 2021 · 3 comments
Labels
area: documentation priority: low type: enhancement Changes or improvements to existing features
Milestone

Comments

@lemonsaurus
Copy link
Member

The readme should contain information on how to install this via PyPI, how to use the API, where the assets are located, the difference between ducks and man-ducks, and everything else related to this.

It should probably have collapsible sections, maybe a table of contents, and lots of pictures of duckies!

@lemonsaurus lemonsaurus added area: documentation priority: low type: enhancement Changes or improvements to existing features labels Apr 1, 2021
@lemonsaurus lemonsaurus added this to the v1.0.0 milestone Apr 1, 2021
@Kronifer
Copy link

hey @lemonsaurus is this availiable??

@jb3
Copy link
Member

jb3 commented May 13, 2021

it is, but we're waiting on more things to be ready to do this.

For example, the issue mentions PyPI installation and API usage, things we should probably bring to a more production ready state before we start writing lots of documentation.

@Kronifer
Copy link

So then, wait for the cli to be finished, and seeding iirc

@jb3 jb3 modified the milestones: v1.0.0, Production Aug 23, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation priority: low type: enhancement Changes or improvements to existing features
Projects
None yet
Development

No branches or pull requests

3 participants