Add information about how to actually use it to the readme

mosjs / mos

:pill: A pluggable module that injects content into your markdown files via hidden JavaScript snippets

108 stars 8 forks source link

Add information about how to actually use it to the readme #93

Open antony opened 7 years ago

antony commented 7 years ago

Right now the readme says how to require a module. That's pretty obvious.

What I would like to know is:

usage
configuration
main methods I can call
troubleshooting
caveats

zkochan commented 7 years ago

Hey, I am on vacation now but maybe next week I can help you. TBH, I really like this project and wanted to make it a lot better but right now I focused all my energy on pnpm.

Would an example project help you to understand?