Merge pull request #4 from pka/readme-cargo-tweaks

deepbludev · web-flow · commit bfa3ee9a63e6 · 2024-10-19T22:36:14.000+02:00
diff --git a/datasets/highways/Cargo.toml b/datasets/highways/Cargo.toml
@@ -5,7 +5,8 @@ edition = "2021"
 description = "Highways dataset for routrs, the geograph-based shortest distance calculator for Rust"
 license = "MIT"
 repository = "https://github.com/deepbludev/routrs"
-documentation = "https://github.com/deepbludev/routrs"
+keywords = ["pathfinding", "routing"]
+categories = ["algorithms", "science::geo"]
 
 [dependencies]
 flate2 = "1.0.28"
diff --git a/datasets/maritime/Cargo.toml b/datasets/maritime/Cargo.toml
@@ -5,7 +5,8 @@ edition = "2021"
 description = "Maritime dataset for routrs, the geograph-based shortest distance calculator for Rust"
 license = "MIT"
 repository = "https://github.com/deepbludev/routrs"
-documentation = "https://github.com/deepbludev/routrs"
+keywords = ["pathfinding", "routing"]
+categories = ["algorithms", "science::geo"]
 
 [dependencies]
 flate2 = "1.0.28"
diff --git a/datasets/maritime/README.md b/datasets/maritime/README.md
@@ -1,2 +1,2 @@
-# routrs_highways
-Highway extension for routrs, the Rust geograph-based shortest distance calculator
+# routrs_maritime
+Maritime dataset for routrs, the geograph-based shortest distance calculator for Rust.
diff --git a/datasets/railways/Cargo.toml b/datasets/railways/Cargo.toml
@@ -5,7 +5,8 @@ edition = "2021"
 description = "Railways dataset for routrs, the geograph-based shortest distance calculator for Rust"
 license = "MIT"
 repository = "https://github.com/deepbludev/routrs"
-documentation = "https://github.com/deepbludev/routrs"
+keywords = ["pathfinding", "routing"]
+categories = ["algorithms", "science::geo"]
 
 [dependencies]
 flate2 = "1.0.28"
diff --git a/examples/Cargo.toml b/examples/Cargo.toml
@@ -5,7 +5,6 @@ edition = "2021"
 description = "Examples for routrs"
 license = "MIT"
 repository = "https://github.com/deepbludev/routrs"
-documentation = "https://github.com/deepbludev/routrs"
 
 [dependencies]
 routrs = { version = "2.0.0", path = "../lib", features = ["all"] }
diff --git a/examples/README.md b/examples/README.md
@@ -1,2 +1,11 @@
-# routrs_highways
-Highway extension for routrs, the Rust geograph-based shortest distance calculator
+# routrs_examples
+
+Examples for routrs.
+
+To run the examples:
+```bash
+cargo run -p routrs_examples --bin maritime
+cargo run -p routrs_examples --bin highways
+cargo run -p routrs_examples --bin railways
+cargo run -p routrs_examples --bin concurrency
+```
diff --git a/lib/Cargo.toml b/lib/Cargo.toml
@@ -5,8 +5,9 @@ edition = "2021"
 description = "Geograph-based shortest distance calculation for Rust"
 license = "MIT"
 repository = "https://github.com/deepbludev/routrs"
-documentation = "https://github.com/deepbludev/routrs"
-
+readme = "../README.md"
+keywords = ["pathfinding", "routing"]
+categories = ["algorithms", "science::geo"]
 
 [features]
 default = ["core"]
diff --git a/lib/README.md b/lib/README.md
