JuliaGeo / GADM.jl

A Julia package for obtaining geographical data from the GADM dataset
https://gadm.org
MIT License
38 stars 4 forks source link

Write a README.md file with examples #20

Closed juliohm closed 3 years ago

juliohm commented 3 years ago

Try to follow the convention of this README: https://github.com/JuliaEarth/ExtremeStats.jl

An installation and an usage section at least. :+1:

juliohm commented 3 years ago

This is a package from another MLH fellow last year who did really well: https://github.com/JuliaClimate/CDSAPI.jl

juliohm commented 3 years ago

Before we close this, it would be nice to add somewhere in the README that these are the coordinates we get from the GADM website:

The coordinate reference system is longitude/latitude and the WGS84 datum.
zerefwayne commented 3 years ago
juliohm commented 3 years ago

Also, we need to update the README to reflect the fact that now get and coordinates always return a MultiPolygon.

juliohm commented 3 years ago

@zerefwayne can you fix this issue? I think it is a quick fix and an important one.

zerefwayne commented 3 years ago

@juliohm I'll properly work on the README after merging the get refactor PR.

juliohm commented 3 years ago

I think we are ready now to update the README :) Please submit a PR with the readme changes and I can provide feedback :+1:

juliohm commented 3 years ago

Fixed on master :+1: