Skip to content

Commit

Permalink
First Commit
Browse files Browse the repository at this point in the history
  • Loading branch information
roberdam committed Aug 9, 2016
0 parents commit ae8b309
Show file tree
Hide file tree
Showing 183 changed files with 703,066 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2016 Roberto Dam

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
88 changes: 88 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
![Logo](https://cloud.githubusercontent.com/assets/3354868/17249828/b7e84ef0-556f-11e6-80e7-10bd51c46143.png)
# XADDRESS
Give 7 billion people an instant physical address that can be used offline and decoded with low tech (pen & paper).

## How it works.
<img src="https://cloud.githubusercontent.com/assets/3354868/17251870/6bdbda00-5578-11e6-9162-1e5200cffa34.gif" width="700">

Xaddress encodes the latitude & longitude of a place in a form that resembles a normal address and can be decoded back easily even in a low tech environment using paper, pen and a physical map.

[TRY IT IN ENGLISH](http://www.xaddress.org/try?lng=en) | [PRUEBELO EN ESPAÑOL](http://www.xaddress.org/try?lng=es)

```
The demo site uses some free apis with limited requests per day,
some functionality might be unavailable on high demand.
```
## How it looks
![looks] (https://cloud.githubusercontent.com/assets/3354868/17262858/d616e1ca-55ab-11e6-9d8a-78dd524a4063.png)

## Features
![parts] (https://cloud.githubusercontent.com/assets/3354868/17264547/bc36ac22-55b5-11e6-9aae-e64677c2d5bc.png)
#### 1) VISUAL AVATAR
Used like a visual hash to ensure that you write the Xaddress right, if you change any letter it will generate another image, for example MAGICAL PEARL**S** will show you a different image so you can know that you write a wrong address.

If you want to transmit your Xaddress by phone you will say
> "7150 MAGICAL PEARL - Maluku ,Indonesia" my avatar is a boot
#### 2) COUNTRY AND STATE
You can see right away the country and state where that Xaddress is located, and you can recognize it as an address.

#### 3) SHORT CODE
By default Xaddress create 2 kind of codes, each one independent from the other, the short code can be decoded by itself, it can have 1 Metter accuracy, and is useful to storage or send it as a link, like [ubicate.me/NOMATAL-KOROFAD](http://ubicate.me/NOMATAL-KOROFAD)

## Encoding with the Ruby CLI.
To decode plain latitude & longitude install first the gem geocoder
```
gem install geocoder
```

Then clone this repo and run:
```
ruby encode.rb "-6.7184,129.5080"
```
You can use it without using geocoder by specify state and country in the command line:
```
ruby encode.rb "-6.7184,129.5080" "Maluku, Indonesia"
```
## Decoding with the Ruby CLI.
```
ruby decode.rb "7150 MAGICAL PEARL - Maluku, Indonesia"
```

## PROS:

* Instantaneous.
* Offline
* Designed to be used in low tech environments
* Multilanguage
* Error correction incorporated with visual avatar.
* Short code for storing or linking.
* Works with any map.
* Yow know is an address when you see it.


## CONS:
* May take you some effort to find a suitable address
* 10mts accuracy with the present form.

## ALTERNATIVES:
* [What3words] (http://what3words.com) - Uses 3 words to define any location *percolator.surmount.retooled*, commercial option with a patented algorithm.
* [Geohash] (http://http://geohash.org/) - Free and Opensource *qyu1g0by7*
* [Mapcode] (http://www.mapcode.com/) - Free with Apache License Version 2.0. *VQ6.1MFD*
* [Openlocationcode] (http://openlocationcode.com/) - Free and Opensource *6Q5F 7GJ5+J6*

## Compare encodings:
| Option | Location : -6.7184 , 129.5080 |
| ---------------- |:--------------------------------------:|
| XADDRESS | 7150 Magical Pearl - Maluku, Indonesia |
| WHAT3WORDS | percolator.surmount.retooled |
| GEOHASH | qyu1g0by7 |
| MAPCODE | VQ6.1MFD |
| OPENLOCATIONCODE | 6Q5F 7GJ5+J6 |

## Contributing
There is a lot to do if you want to contribute:
* Mobile App
* Language packs
* Spread the word
* Errors/corrections/improvement, raise an issue on Github and I would be more than happy to discuss :)
Binary file added by_hand/Decode-en.pdf
Binary file not shown.
Binary file added by_hand/Encode-en.pdf
Binary file not shown.
Binary file added by_hand/tables/AE.pdf
Binary file not shown.
Binary file added by_hand/tables/AF.pdf
Binary file not shown.
Binary file added by_hand/tables/AL.pdf
Binary file not shown.
Binary file added by_hand/tables/AM.pdf
Binary file not shown.
Binary file added by_hand/tables/AO.pdf
Binary file not shown.
Binary file added by_hand/tables/AR.pdf
Binary file not shown.
Binary file added by_hand/tables/AT.pdf
Binary file not shown.
Binary file added by_hand/tables/AU.pdf
Binary file not shown.
Binary file added by_hand/tables/AZ.pdf
Binary file not shown.
Binary file added by_hand/tables/BA.pdf
Binary file not shown.
Binary file added by_hand/tables/BD.pdf
Binary file not shown.
Binary file added by_hand/tables/BE.pdf
Binary file not shown.
Binary file added by_hand/tables/BF.pdf
Binary file not shown.
Binary file added by_hand/tables/BG.pdf
Binary file not shown.
Binary file added by_hand/tables/BJ.pdf
Binary file not shown.
Binary file added by_hand/tables/BO.pdf
Binary file not shown.
Binary file added by_hand/tables/BQ.pdf
Binary file not shown.
Binary file added by_hand/tables/BR.pdf
Binary file not shown.
Binary file added by_hand/tables/BS.pdf
Binary file not shown.
Binary file added by_hand/tables/BT.pdf
Binary file not shown.
Binary file added by_hand/tables/BW.pdf
Binary file not shown.
Binary file added by_hand/tables/BY.pdf
Binary file not shown.
Binary file added by_hand/tables/BZ.pdf
Binary file not shown.
Binary file added by_hand/tables/CA.pdf
Binary file not shown.
Binary file added by_hand/tables/CD.pdf
Binary file not shown.
Binary file added by_hand/tables/CF.pdf
Binary file not shown.
Binary file added by_hand/tables/CG.pdf
Binary file not shown.
Binary file added by_hand/tables/CH.pdf
Binary file not shown.
Binary file added by_hand/tables/CI.pdf
Binary file not shown.
Binary file added by_hand/tables/CL.pdf
Binary file not shown.
Binary file added by_hand/tables/CM.pdf
Binary file not shown.
Binary file added by_hand/tables/CN.pdf
Binary file not shown.
Binary file added by_hand/tables/CO.pdf
Binary file not shown.
Binary file added by_hand/tables/CR.pdf
Binary file not shown.
Binary file added by_hand/tables/CU.pdf
Binary file not shown.
Binary file added by_hand/tables/CV.pdf
Binary file not shown.
Binary file added by_hand/tables/CZ.pdf
Binary file not shown.
Binary file added by_hand/tables/DE.pdf
Binary file not shown.
Binary file added by_hand/tables/DK.pdf
Binary file not shown.
Binary file added by_hand/tables/DO.pdf
Binary file not shown.
Binary file added by_hand/tables/DZ.pdf
Binary file not shown.
Binary file added by_hand/tables/EC.pdf
Binary file not shown.
Binary file added by_hand/tables/EE.pdf
Binary file not shown.
Binary file added by_hand/tables/EG.pdf
Binary file not shown.
Binary file added by_hand/tables/ER.pdf
Binary file not shown.
Binary file added by_hand/tables/ES.pdf
Binary file not shown.
Binary file added by_hand/tables/ET.pdf
Binary file not shown.
Binary file added by_hand/tables/FI.pdf
Binary file not shown.
Binary file added by_hand/tables/FJ.pdf
Binary file not shown.
Binary file added by_hand/tables/FM.pdf
Binary file not shown.
Binary file added by_hand/tables/FR.pdf
Binary file not shown.
Binary file added by_hand/tables/GA.pdf
Binary file not shown.
Binary file added by_hand/tables/GB.pdf
Binary file not shown.
Binary file added by_hand/tables/GE.pdf
Binary file not shown.
Binary file added by_hand/tables/GH.pdf
Binary file not shown.
Binary file added by_hand/tables/GL.pdf
Binary file not shown.
Binary file added by_hand/tables/GN.pdf
Binary file not shown.
Binary file added by_hand/tables/GQ.pdf
Binary file not shown.
Binary file added by_hand/tables/GR.pdf
Binary file not shown.
Binary file added by_hand/tables/GT.pdf
Binary file not shown.
Binary file added by_hand/tables/GW.pdf
Binary file not shown.
Binary file added by_hand/tables/GY.pdf
Binary file not shown.
Binary file added by_hand/tables/HN.pdf
Binary file not shown.
Binary file added by_hand/tables/HR.pdf
Binary file not shown.
Binary file added by_hand/tables/HT.pdf
Binary file not shown.
Binary file added by_hand/tables/HU.pdf
Binary file not shown.
Binary file added by_hand/tables/ID.pdf
Binary file not shown.
Binary file added by_hand/tables/IE.pdf
Binary file not shown.
Binary file added by_hand/tables/IL.pdf
Binary file not shown.
Binary file added by_hand/tables/IN.pdf
Binary file not shown.
Binary file added by_hand/tables/IQ.pdf
Binary file not shown.
Binary file added by_hand/tables/IR.pdf
Binary file not shown.
Binary file added by_hand/tables/IS.pdf
Binary file not shown.
Binary file added by_hand/tables/IT.pdf
Binary file not shown.
Binary file added by_hand/tables/JO.pdf
Binary file not shown.
Binary file added by_hand/tables/JP.pdf
Binary file not shown.
Binary file added by_hand/tables/KE.pdf
Binary file not shown.
Binary file added by_hand/tables/KG.pdf
Binary file not shown.
Binary file added by_hand/tables/KH.pdf
Binary file not shown.
Binary file added by_hand/tables/KI.pdf
Binary file not shown.
Binary file added by_hand/tables/KP.pdf
Binary file not shown.
Binary file added by_hand/tables/KR.pdf
Binary file not shown.
Binary file added by_hand/tables/KZ.pdf
Binary file not shown.
Binary file added by_hand/tables/LA.pdf
Binary file not shown.
Binary file added by_hand/tables/LK.pdf
Binary file not shown.
Binary file added by_hand/tables/LR.pdf
Binary file not shown.
Binary file added by_hand/tables/LT.pdf
Binary file not shown.
Binary file added by_hand/tables/LV.pdf
Binary file not shown.
Binary file added by_hand/tables/LY.pdf
Binary file not shown.
Binary file added by_hand/tables/MA.pdf
Binary file not shown.
Binary file added by_hand/tables/MD.pdf
Binary file not shown.
Binary file added by_hand/tables/MG.pdf
Binary file not shown.
Binary file added by_hand/tables/MK.pdf
Binary file not shown.
Binary file added by_hand/tables/ML.pdf
Binary file not shown.
Binary file added by_hand/tables/MM.pdf
Binary file not shown.
Binary file added by_hand/tables/MN.pdf
Binary file not shown.
Binary file added by_hand/tables/MR.pdf
Binary file not shown.
Binary file added by_hand/tables/MU.pdf
Binary file not shown.
Binary file added by_hand/tables/MV.pdf
Binary file not shown.
Binary file added by_hand/tables/MW.pdf
Binary file not shown.
Binary file added by_hand/tables/MX.pdf
Binary file not shown.
Binary file added by_hand/tables/MY.pdf
Binary file not shown.
Binary file added by_hand/tables/MZ.pdf
Binary file not shown.
Binary file added by_hand/tables/NA.pdf
Binary file not shown.
Binary file added by_hand/tables/NE.pdf
Binary file not shown.
Binary file added by_hand/tables/NG.pdf
Binary file not shown.
Binary file added by_hand/tables/NI.pdf
Binary file not shown.
Binary file added by_hand/tables/NL.pdf
Binary file not shown.
Binary file added by_hand/tables/NO.pdf
Binary file not shown.
Binary file added by_hand/tables/NP.pdf
Binary file not shown.
Binary file added by_hand/tables/NZ.pdf
Binary file not shown.
Binary file added by_hand/tables/OM.pdf
Binary file not shown.
Binary file added by_hand/tables/PA.pdf
Binary file not shown.
Binary file added by_hand/tables/PE.pdf
Binary file not shown.
Binary file added by_hand/tables/PG.pdf
Binary file not shown.
Binary file added by_hand/tables/PH.pdf
Binary file not shown.
Binary file added by_hand/tables/PK.pdf
Binary file not shown.
Binary file added by_hand/tables/PL.pdf
Binary file not shown.
Binary file added by_hand/tables/PT.pdf
Binary file not shown.
Binary file added by_hand/tables/PY.pdf
Binary file not shown.
Binary file added by_hand/tables/RO.pdf
Binary file not shown.
Binary file added by_hand/tables/RU.pdf
Binary file not shown.
Binary file added by_hand/tables/SA.pdf
Binary file not shown.
Binary file added by_hand/tables/SB.pdf
Binary file not shown.
Binary file added by_hand/tables/SC.pdf
Binary file not shown.
Binary file added by_hand/tables/SD.pdf
Binary file not shown.
Binary file added by_hand/tables/SE.pdf
Binary file not shown.
Binary file added by_hand/tables/SH.pdf
Binary file not shown.
Binary file added by_hand/tables/SJ.pdf
Binary file not shown.
Binary file added by_hand/tables/SK.pdf
Binary file not shown.
Binary file added by_hand/tables/SL.pdf
Binary file not shown.
Binary file added by_hand/tables/SN.pdf
Binary file not shown.
Binary file added by_hand/tables/SO.pdf
Binary file not shown.
Binary file added by_hand/tables/SR.pdf
Binary file not shown.
Binary file added by_hand/tables/SS.pdf
Binary file not shown.
Binary file added by_hand/tables/SY.pdf
Binary file not shown.
Binary file added by_hand/tables/TD.pdf
Binary file not shown.
Binary file added by_hand/tables/TG.pdf
Binary file not shown.
Binary file added by_hand/tables/TH.pdf
Binary file not shown.
Binary file added by_hand/tables/TJ.pdf
Binary file not shown.
Binary file added by_hand/tables/TM.pdf
Binary file not shown.
Binary file added by_hand/tables/TN.pdf
Binary file not shown.
Binary file added by_hand/tables/TO.pdf
Binary file not shown.
Binary file added by_hand/tables/TR.pdf
Binary file not shown.
Binary file added by_hand/tables/TV.pdf
Binary file not shown.
Binary file added by_hand/tables/TZ.pdf
Binary file not shown.
Binary file added by_hand/tables/UA.pdf
Binary file not shown.
Binary file added by_hand/tables/UG.pdf
Binary file not shown.
Binary file added by_hand/tables/US.pdf
Binary file not shown.
Binary file added by_hand/tables/UY.pdf
Binary file not shown.
Binary file added by_hand/tables/UZ.pdf
Binary file not shown.
Binary file added by_hand/tables/VE.pdf
Binary file not shown.
Binary file added by_hand/tables/VN.pdf
Binary file not shown.
Binary file added by_hand/tables/VU.pdf
Binary file not shown.
Binary file added by_hand/tables/YE.pdf
Binary file not shown.
Binary file added by_hand/tables/ZA.pdf
Binary file not shown.
Binary file added by_hand/tables/ZM.pdf
Binary file not shown.
Binary file added by_hand/tables/ZW.pdf
Binary file not shown.
Loading

0 comments on commit ae8b309

Please sign in to comment.