Skip to content

Latest commit

 

History

History
75 lines (45 loc) · 2.36 KB

README.md

File metadata and controls

75 lines (45 loc) · 2.36 KB
Raw

breakdance-cli NPM version NPM monthly downloads NPM total downloads

CLI for breakdance, the HTML to markdown converter for node.js.

Install

Install with npm:

$ npm install --save breakdance-cli

Getting started

If you want to see how breakdance works, the CLI is the fastest way to get started.

Installing the CLI

Install the breakdance CLI with npm:

$ npm install  --global breakdance-cli

This adds the bd command to your system path, allowing you to run the breakdance CLI from any directory.

$ bd
# also aliased as "breakdance" in case of conflicts
$ breakdance

See the breakdance documentation for more information about usage and options.

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on May 12, 2017.