Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
asinghvi17 authored May 7, 2024
1 parent e156ad7 commit 4de6c5a
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,18 @@ Currently, this package provides a single function, `naturalearth`, which fetche

The data is downloaded on demand and cached using Julia's scratch space system. This means that the first time you fetch a dataset, it will take a while to download, and you will need an internet connection. Subsequent calls will be much faster, even in a new session.

## Quick start

You can install the Natural Earth package through the Julia package manager: `using Pkg; Pkg.add("NaturalEarth")`. The main entry point is the `naturalearth(dataset, [scale])` function which returns a `GeoJSON.FeatureCollection` from [GeoJSON.jl](https://github.com/JuliaGeo/GeoJSON.jl).

```julia
using NaturalEarth
naturalearth("admin_0_countries", 110) # this resolves to `ne_110m_admin_0_countries.geojson`
naturalearth("10m_admin_0_countries") # this gets the 10m-scale, but explicitly
```
These return `GeoJSON.FeatureCollections`, which you can either use as-is or convert to `DataFrames` (by `DataFrame(naturalearth(...))`).
## Acknowledgements

All datasets are provided by [Natural Earth](http://www.naturalearthdata.com/).

Initial development by [Haakon Ludvig Langeland Ervik](https://github.com/haakon-e)
Initial development by [Haakon Ludvig Langeland Ervik](https://github.com/haakon-e)

0 comments on commit 4de6c5a

Please sign in to comment.