Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
AnthonyNeace committed May 26, 2015
1 parent aba8588 commit 86bc72c
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ A library containing utility methods to manage ActiveWorlds coordinates as strin

## Usage

This library deals with strings of the format:

<WORLDNAME> <NORTH/SOUTH POSITION> <EAST/WEST POSITION> <ALTITUDE> <DIRECTION>

Valid formats:

* Worldname: At least two non-whitespace characters.
* North/South Position: Integers ending in N/n or S/s.
* East/West Position: Integers ending in E/e or W/w.
* Altitude: Integer or decimal ending in A/a.
* Direction: Non-negative integers from 0 to 360.

Example:

var awcoordinates = require('awcoordinates'),
find = awcoordinates.find;

Expand Down

0 comments on commit 86bc72c

Please sign in to comment.