# 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)

[English](./README.md)

> :beer: :rocket:  专为开发者打造的一款用于快速找到需要的文档的命令行工具。构建于 [Node.js](https://nodejs.org/en/) 之上。

## 安装

这是一个构建于 [Node.js](https://nodejs.org/en/) 的命令行工具，因此要求 **你电脑中装有 [Node.js](https://nodejs.org/en/)>= 4 环境。**

使用 [npm](https://github.com/npm/npm) 进行全局安装：

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

## 使用

```bash
comeon <name>
```

### 更多功能

```js
$ comeon list // 显示所有的 package 列表
```

## 更新本地缓存？

使用 `comeon update` 从 [GitHub](https://github.com/sqrthree/comeon) 上获取 `comeon` 最新的数据。

## 贡献

非常期待一起完善 `comeon`，使其帮助到更多的开发者。查看 [CONTRIBUTING.md](./CONTRIBUTING.md) 了解更多信息以及如何开始。

## License

`comeon` 基于 [MIT](https://github.com/sqrthree/comeon/blob/master/LICENSE) 协议。

那么，尽情享用吧！
