diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..31aa793 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..09e7108 --- /dev/null +++ b/README.md @@ -0,0 +1,19 @@ +# h3ron + +[h3](https://h3geo.org) library for [rust](https://rustlang.org) + +This repository consists of multiple crates: + +* [h3ron-h3-sys](./h3ron-h3-sys): bindgen-generated bindings for statically linked libh3. +* [h3ron](./h3ron): high level rust API including collections for selected parts of H3. +* [h3ron-ndarray](./h3ron-ndarray): Integration with the [ndarray](https://github.com/rust-ndarray/ndarray) crate to generate H3 data from raster data (using [gdal](https://github.com/georust/gdal), ...) + +## Why this name? + +Well, coming up with a good name for a project while avoiding naming conflicts is hard. On the other hand are animal-based names always pretty easy to remember. + +How to pronounce it? I got no idea - probably like the [heron bird family](https://en.wikipedia.org/wiki/Heron). + +## License + +[MIT](./LICENSE-MIT) \ No newline at end of file diff --git a/h3ron-h3-sys/Cargo.toml b/h3ron-h3-sys/Cargo.toml index ae79f2b..64834d8 100644 --- a/h3ron-h3-sys/Cargo.toml +++ b/h3ron-h3-sys/Cargo.toml @@ -1,11 +1,12 @@ [package] name = "h3ron-h3-sys" version = "3.7.1" # version matches the bundled libh3 -description = "bindings to libh3, bindgen generated, libh3 is bundled" +description = "bindgen-generated bindings for statically linked libh3" authors = ["Nico Mandery "] build = "build.rs" license = "MIT" edition = "2018" +keywords = ["geo", "spatial", "h3"] [lib] diff --git a/h3ron-ndarray/Cargo.toml b/h3ron-ndarray/Cargo.toml index a3577c0..cffdbfd 100644 --- a/h3ron-ndarray/Cargo.toml +++ b/h3ron-ndarray/Cargo.toml @@ -1,8 +1,11 @@ [package] name = "h3ron-ndarray" -version = "0.1.0" +version = "0.4.0" authors = ["Nico Mandery "] +description = "Integration with the ndarray crate to generate H3 data from raster data (using gdal, ...)" edition = "2018" +license = "MIT" +keywords = ["geo", "spatial", "h3", "ndarray"] [dependencies] geo-types = "^0.6" @@ -11,7 +14,7 @@ log = "^0.4" [dependencies.ndarray] version = "^0.14" -features = [ "rayon" ] +features = ["rayon"] [dependencies.h3ron] path = "../h3ron" @@ -24,7 +27,7 @@ criterion = "^0.3" [dev-dependencies.gdal] version = "^0.7" -features = [ "array" ] +features = ["array"] [[bench]] diff --git a/h3ron/Cargo.toml b/h3ron/Cargo.toml index cabff68..abdcbd8 100644 --- a/h3ron/Cargo.toml +++ b/h3ron/Cargo.toml @@ -1,8 +1,11 @@ [package] name = "h3ron" -version = "0.3.3" +description = "high level rust API including collections for selected parts of H3" +version = "0.4.0" authors = ["Nico Mandery "] edition = "2018" +license = "MIT" +keywords = ["geo", "spatial", "h3"] [dependencies] h3ron-h3-sys = { path = "../h3ron-h3-sys" }