From 4de6c5ad235d7ea649df45a3a065bedb73083d91 Mon Sep 17 00:00:00 2001 From: Anshul Singhvi Date: Tue, 7 May 2024 13:10:19 -0400 Subject: [PATCH] Update README.md --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 649ed83..03e23a4 100644 --- a/README.md +++ b/README.md @@ -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) \ No newline at end of file +Initial development by [Haakon Ludvig Langeland Ervik](https://github.com/haakon-e)