https://github.com/haysclark/cli-docs

Helper library for reading individual local text files for more scalable CLI documentation.
https://github.com/haysclark/cli-docs

Last synced: 14 days ago
JSON representation

Helper library for reading individual local text files for more scalable CLI documentation.

• Host: GitHub
• URL: https://github.com/haysclark/cli-docs
• Owner: haysclark
• License: mit
• Created: 2015-11-29T21:23:53.000Z (about 9 years ago)
• Default Branch: develop
• Last Pushed: 2015-11-30T08:35:43.000Z (about 9 years ago)
• Last Synced: 2024-11-27T21:13:16.017Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/cli-docs
• Size: 7.81 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
cli-docs [![Build Status](https://travis-ci.org/haysclark/cli-docs.svg)](https://travis-ci.org/haysclark/cli-docs)[![Coverage Status](https://coveralls.io/repos/haysclark/cli-docs/badge.svg?branch=develop&service=github)](https://coveralls.io/github/haysclark/cli-docs?branch=develop)[![npm version](https://badge.fury.io/js/cli-docs.svg)](http://badge.fury.io/js/cli-docs)

========

Helper library for reading individual local text files for more scalable CLI documentation.

## Installation

    npm install cli-docs --save-dev

## Usage

In you CLI tool setup the service.

    var docs = require('cli-docs')({

        suffix: 'txt',     // file suffix for your docs

        basepath: '../doc' // path to your docs

    });

To read a docs file simply provide the name.

    docs.read('example', function(err, data) {

        console.log(data);

    });

## Development

    npm install

    npm link

## Running tests

    npm test

    npm run coverage

## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style.

Add unit tests for any new or changed functionality. Lint and test your code.

## Release History

* 0.0.1 bleeding edge