Skip to content
This repository has been archived by the owner on Jul 14, 2019. It is now read-only.

Documentation please #3

Open
fresheneesz opened this issue Jun 30, 2017 · 2 comments
Open

Documentation please #3

fresheneesz opened this issue Jun 30, 2017 · 2 comments

Comments

@fresheneesz
Copy link

Could you please document the API in the readme file?
@bartv2
Copy link
Owner

bartv2 commented Jul 12, 2017

The best documentation at the moment is the demo. It provides a working example on how to use this.

@fresheneesz
Copy link
Author

@bartv2 Ok.. but demos are not API documentation. If you want people to use this module, documentation is the best place to start. Doesn't take a lot of time.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@fresheneesz @bartv2