Expose the API and simple examples at first in the README
Open
- Dominant language
- JavaScript
- Stars
- 5
- Forks
- 1
- PR merge metrics
- No merged PRs in 30d
Description
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?
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.