Documentation of Modules in README.md - Githubissues

rcorp / standard-project-structure

A mission to improve developer productivity. Automate Everything ™ !

Apache License 2.0

5 stars 3 forks source link

Documentation of Modules in README.md #58

Open gaurav21r opened 7 years ago

gaurav21r commented 7 years ago

In README.md, we need to give very succinct view of usage of each module. So for example, for liniting we can have something like

Code Linting

All code should look like a single person typed it, no matter how many people contributed so its easy to read and contribute.
{{Other Intros}}
Installation

sps init linter

Asks for all languages being used.
Installs tasks for each linter.
Asks for Editors being used and installs editor Plugins.
Usage

grunt lint

Runs all linters installed.
Tools Used

{{ Table of all the Linters along with why }}

And finally a Read More ...