sascha/hipku
1
0
Fork 0
mirror of https://github.com/gabemart/hipku.git synced 2025-10-31 07:03:40 +00:00
Code Issues Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
gabemart
2016-09-02 18:17:16 +01:00
parent 8ff2cdc1a0
commit 743c83e678
2 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@@ -6,7 +6,7 @@ For full documentation and a working demo, check out http://gabrielmartin.net/pr
## Installation ## 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 ## Usage
@@ -17,17 +17,17 @@ When decoding a hipku, such as:
The weary red dove The weary red dove
fights in the empty tundra. fights in the empty tundra.
Jasmine petals dance. Jasmine petals dance.
the lines can be separated either by the newline character `\n` or by a space. Both will produce the same result. 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.'); Hipku.decode('The weary red dove\nfights in the empty tundra.\nJasmine petals dance.');
> "254.53.93.114" > "254.53.93.114"
Hipku.decode('The weary red dove fights in the empty tundra. Jasmine petals dance.'); Hipku.decode('The weary red dove fights in the empty tundra. Jasmine petals dance.');
> "254.53.93.114" > "254.53.93.114"
### Node.js ### Node.js
var hipku = require('hipku'); var hipku = require('hipku');

2
package.json
View File

@@ -1,6 +1,6 @@
{ {
"name": "hipku", "name": "hipku",
"version": "1.0.0", "version": "1.0.1",
"description": "Encode any IP address as a haiku", "description": "Encode any IP address as a haiku",
"main": "index.js", "main": "index.js",
"devDependencies": { "devDependencies": {