Encode any IP address as a haiku
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Hipku

A tiny javascript library to encode IPv6 and IPv4 addresses as haiku.

For full documentation and a working demo, check out http://gabrielmartin.net/projects/hipku

Installation

Install with npm install hipku. index.js can also be used directly in the browser.

Usage

To encode 127.0.0.1 or ::1 call Hipku.encode('127.0.0.1') or Hipku.encode('::1'). IPv4 addresses must have octets separated by a . period character and IPv6 addresses must have hextets separated by a : colon character.

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');

hipku.encode('127.0.0.1');

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