fix the readme so that it describes how to use the module, not how it works

aldrichtr / PSOrgMode

A module for reading and writing the org-mode markup format

0 stars 0 forks source link

fix the readme so that it describes how to use the module, not how it works #9

Closed aldrichtr closed 2 years ago

aldrichtr commented 2 years ago

The readme should be a user-manual, not a developer's notes. Start with an overview, then how to install, then a breakdown of the functions. Add links to:

[ ] developer notes
[ ] contributing guidelines
[ ] license info
[ ] more detailed help.

aldrichtr commented 2 years ago

Closed by 14e8485ba05c33c97379a5f8b9b04854776cb4c2