Skip to content

Expose the API and simple examples at first in the README #1

Description

@vvo

The project could be easier to understand by having a more API focused README:

  • show a simple example. Not doing an export, just using the API and showing what are the main features of the lib
  • detail the API right away
  • maybe explain the problem in a blogpost rather than in the README

What do you think?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions