Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
gabemart committed Sep 2, 2016
1 parent 8ff2cdc commit 743c83e
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ For full documentation and a working demo, check out http://gabrielmartin.net/pr

## Installation

Install with `npm install hipku` or use a browser-ready file in the `dist` folder.
Install with `npm install hipku`. `index.js` can also be used directly in the browser.

## Usage

Expand All @@ -17,17 +17,17 @@ When decoding a hipku, such as:
The weary red dove
fights in the empty tundra.
Jasmine petals dance.

the lines can be separated either by the newline character `\n` or by a space. Both will produce the same result.

Hipku.decode('The weary red dove\nfights in the empty tundra.\nJasmine petals dance.');

> "254.53.93.114"

Hipku.decode('The weary red dove fights in the empty tundra. Jasmine petals dance.');

> "254.53.93.114"

### Node.js

var hipku = require('hipku');
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "hipku",
"version": "1.0.0",
"version": "1.0.1",
"description": "Encode any IP address as a haiku",
"main": "index.js",
"devDependencies": {
Expand Down

0 comments on commit 743c83e

Please sign in to comment.