From 4614f9fbac4e532ab878f8e423adfb68274c8041 Mon Sep 17 00:00:00 2001 From: Skylar Ittner Date: Fri, 5 Nov 2021 18:04:21 -0600 Subject: [PATCH] Add readme --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..608aac0 --- /dev/null +++ b/README.md @@ -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) \ No newline at end of file