docor

a tiny cli tool to create elegant readme by manifest files, like package.json, bower.json and manifest.json

Installation

$ [sudo] npm install docor -g

Usage

The very first, Ensure excutes docor in directory where contains one manifest file in support manifest files. As a cli tool, Docor will create these files: README.md ,license .gitignore and .npmignore.

$ docor

Supported manifest files

• package.json: NPM manifest.
• bower.json: The front-end package manager Bower's manifest.
• manifest.json: Chrome App's manifest.

Example

To run built-in examples:

$ git clone [email protected]:turingou/docor.git
$ cd docor
$ npm install
$ npm run example

Contributing

• Fork this repo
• Clone your repo
• Install dependencies
• Checkout a feature branch
• Feel free to add your features
• Make sure your features are fully tested
• Open a pull request, and enjoy <3

MIT license

Copyright (c) 2013 turing <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

generated using docor @ 0.0.4. brought to you by turing