# comeon

[![Greenkeeper badge](https://badges.greenkeeper.io/sqrthree/comeon.svg)](https://greenkeeper.io/)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![npm](https://img.shields.io/npm/v/comeon.svg)](https://www.npmjs.com/package/comeon)
[![npm](https://img.shields.io/npm/l/comeon.svg)](https://www.npmjs.com/package/comeon)
[![Build Status](https://travis-ci.org/sqrthree/comeon.svg?branch=master)](https://travis-ci.org/sqrthree/comeon)
[![Coverage Status](https://coveralls.io/repos/github/sqrthree/comeon/badge.svg?branch=master)](https://coveralls.io/github/sqrthree/comeon?branch=master)
[![David](https://img.shields.io/david/sqrthree/comeon.svg)](https://www.npmjs.com/package/comeon)

[中文介绍](./README-zh.md)

> :beer: :rocket:  Fast, simple, flexible, usefully command line tool for developers to open documents with the fastest way. based on [Node.js](https://nodejs.org/en/).

## Installation

This is a command line tool based on [Node.js](https://nodejs.org/en/). **You’ll need to have Node >= 4 on your machine.**

Install it once globally:

```bash
$ npm install -g comeon
```

## Usage

```bash
comeon <name>
```

### More feature

```js
$ comeon list // show all available packages
```

## How to Update local cache?

Use `comeon update` to fetch the newest data source of `comeon` from [GitHub](https://github.com/sqrthree/comeon).

## Contributing

Contributions are always welcome, we'd love to have your helping hand on `comeon`. See [CONTRIBUTING.md](./CONTRIBUTING.md) for more information on what we're looking for and how to get started.

Your favourite document isn't covered? Add it to [lib/database.json](https://github.com/sqrthree/comeon/blob/master/lib/database.json) to help us improve it together.

## License

`comeon` is licensed under the [MIT](https://github.com/sqrthree/comeon/blob/master/LICENSE).

So, just enjoy it.