Skip to content

Write formal documentation #26

@leonelquinteros

Description

@leonelquinteros

Please describe your issue

The only documentation for this package is Godoc and the README.md file from this repo. We need to write better docs, some tutorial and use case examples to make package adoption easier.

Is this a bug, an improvement, a proposal or something else? Describe it.

Improvement

What's the expected behaviour, the current behaviour and the steps to reproduce it?

We don't have documentation. We want to have documentation

Comments

Decide between a Github page or the Wiki for this.

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions