Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write a README.md file with examples #20

Closed
juliohm opened this issue Nov 4, 2020 · 8 comments
Closed

Write a README.md file with examples #20

juliohm opened this issue Nov 4, 2020 · 8 comments
Assignees

Comments

@juliohm
Copy link
Member

juliohm commented Nov 4, 2020

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

An installation and an usage section at least. 👍

@juliohm
Copy link
Member Author

juliohm commented Nov 4, 2020

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

@zerefwayne zerefwayne self-assigned this Nov 4, 2020
@juliohm
Copy link
Member Author

juliohm commented Nov 7, 2020

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
Copy link
Collaborator

zerefwayne commented Nov 8, 2020

  • Add coordinate reference system
  • Display plot of India
  • Add API for coordinates and its response
  • Add GADM License Link

@juliohm
Copy link
Member Author

juliohm commented Nov 8, 2020

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

@juliohm
Copy link
Member Author

juliohm commented Nov 10, 2020

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

@zerefwayne
Copy link
Collaborator

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

@juliohm
Copy link
Member Author

juliohm commented Nov 11, 2020

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

@juliohm
Copy link
Member Author

juliohm commented Nov 12, 2020

Fixed on master 👍

@juliohm juliohm closed this as completed Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants