the-script-doc ========== [![Build Status][bd_travis_shield_url]][bd_travis_url] [![npm Version][bd_npm_shield_url]][bd_npm_url] [![JS Standard][bd_standard_shield_url]][bd_standard_url] [bd_repo_url]: https://github.com/the-labo/the-script-doc [bd_travis_url]: http://travis-ci.org/the-labo/the-script-doc [bd_travis_shield_url]: http://img.shields.io/travis/the-labo/the-script-doc.svg?style=flat [bd_travis_com_url]: http://travis-ci.com/the-labo/the-script-doc [bd_travis_com_shield_url]: https://api.travis-ci.com/the-labo/the-script-doc.svg?token= [bd_license_url]: https://github.com/the-labo/the-script-doc/blob/master/LICENSE [bd_codeclimate_url]: http://codeclimate.com/github/the-labo/the-script-doc [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/the-labo/the-script-doc.svg?style=flat [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/the-labo/the-script-doc.svg?style=flat [bd_gemnasium_url]: https://gemnasium.com/the-labo/the-script-doc [bd_gemnasium_shield_url]: https://gemnasium.com/the-labo/the-script-doc.svg [bd_npm_url]: http://www.npmjs.org/package/the-script-doc [bd_npm_shield_url]: http://img.shields.io/npm/v/the-script-doc.svg?style=flat [bd_standard_url]: http://standardjs.com/ [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg Doc script for the-project Installation ----- ```bash $ npm install the-script-doc --save ``` Usage --------- ```javascript 'use strict' const doc = require('the-script-doc') async function tryExample () { await doc('my_project_dir') } tryExample().catch(console.error) ``` License ------- This software is released under the [MIT License](https://github.com/the-labo/the-script-doc/blob/master/LICENSE). Links ------ + [THE Labo][the_labo_url] [the_labo_url]: https://github.com/the-labo