search

bartv2 / quill-delta-markdown

To and from Markdown and Quill delta
23 stars 30 forks source link

Documentation please #3

Open fresheneesz opened 7 years ago

fresheneesz commented 7 years ago

Could you please document the API in the readme file?

bartv2 commented 7 years ago

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

fresheneesz commented 7 years ago

@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.