Skip to content

Needs api documentation #1

@phenax

Description

@phenax

The api is pretty simple but still a formal api documentation is required for the project explaining what the function does, it's example use cases and it's type signature. The documentation should be kept inside the /docs directory as markdown files.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationChanges to the documentation or readme filegood first issueGood for newcomershelp wantedExtra attention is needed

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions