Add readme

This commit is contained in:
Skylar Ittner 2021-11-05 18:04:21 -06:00
parent 0c1be11c43
commit 4614f9fbac

16
README.md Normal file
View File

@ -0,0 +1,16 @@
FixPhrase
=========
FixPhrase is a simple algorithm and word list that enable converting a pair of GPS coordinates to
a four-word phrase and back again.
There are currently JavaScript and PHP libraries available. Both are a single file containing the
word list and the encode/decode algorithms, and both function identically.
Features
--------
* The words can be input in any order without affecting the output coordinates
* Accurate to 12 meters or better
* The first two words of a phrase (when the words are ordered alphabetically) are sufficient to locate
a city (accuracy better than 12km)