mirror of
https://github.com/gabemart/hipku.git
synced 2025-02-21 12:28:10 +00:00
Update README
This commit is contained in:
parent
8ff2cdc1a0
commit
743c83e678
12
README.md
12
README.md
@ -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
|
||||
|
||||
@ -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');
|
||||
|
@ -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": {
|
||||
|
Loading…
x
Reference in New Issue
Block a user