Skip to content

Commit

Permalink
Update README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
denysdovhan committed Sep 5, 2016
1 parent 795ddf5 commit d41e3e8
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 29 deletions.
40 changes: 12 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,45 +5,29 @@
[![Coveralls Status][coveralls-image]][coveralls-url]
[![Dependency Status][depstat-image]][depstat-url]

> Command line interface to emojify-text
> Command line interface to [emojify-text](https://github.com/denysdovhan/emojify-text)
## Install

npm install --save emojify-text-cli
npm install -g emojify-text-cli

## Usage

```js
import { emojifyTextCli, emojifyTextCliAsync } from 'emojify-text-cli';

emojifyTextCli('unicorns'); // unicorns
emojifyTextCliAsync('unicorns')
.then(result => console.log(result)); // unicorns
```
$ emojify-text --help
## API

### emojifyTextCli(input, [options])

### emojifyTextCliAsync(input, [options])

Return a promise that resolves to `result`.

#### input
Command line interface to emojify-text
*Required*
Type: `String`
Usage
$ emojify-text <bg> <fg> <text> [...]
Lorem ipsum.
Options
-r, --row Print emojis in row.
#### options

##### foo

Type: `Boolean`
Default: `false`

Lorem ipsum.
Examples
$ emojify-text ⭐️ 💙 'lol'
$ emojify-text ⭐️ 💙 I love emojis
```

## License

Expand Down
2 changes: 1 addition & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import emogifyText from 'emojify-text'
*/
const cli = meow(`
Usage
$ emojify-text <bg> <fg> <text>
$ emojify-text <bg> <fg> <text> [...]
Options
-r, --row Print emojis in row.
Expand Down

0 comments on commit d41e3e8

Please sign in to comment.