Skip to content

Please add “quick start” w/install+usage to README #33

@bionicles

Description

@bionicles

To know how to begin, as a developer, I like to follow some install + usage guide in the readme rather than hunt around. Could we add a couple code blocks to the readme for how to install this and do basic CRUD / use cases?

This project would be more useful with a README (rather than a folder of docs which is hard to parse, just show us how to begin and use it right away)

A full API doc would be handy but is more work with diminished return. Just install and usage examples would be 80:20

Remember README is like the front page first impression of the project. If the README looks legit, so does the project, and by extension, the contributors. Thanks for making this

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions