Prepare release v0.2.0

CHANGELOG.md

@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.2.0] - 2024-08-13
+
+### Added
+
+- `osmx-rs` CLI command, which includes an `extract` subcommand to turn an `.osm.pbf` file into a `.osmx` database, and a `stat` command which prints statistics about the contents of an `.osmx` database.
+
+## [0.1.0] - 2024-03-06
+
+Initial release.
+
+Supports reading `.osmx` files, including:
+
+- fetching nodes, ways and relations by ID
+- reading an element's tags
+- getting a node's location, a way's nodes, or a relation's members
+- finding nodes in a region using the spatial index
+- getting reverse relationships (finding all ways that a node is part of, or all relations that an element is a member of)
+
+Does not yet support:
+
+- reading element metadata (e.g. the version number of an element or the changeset and user that most recently modified it)
+- writing data to an .osmx database, or creating a new .osmx database
+
+
+
+[unreleased]: https://github.com/jake-low/osmx-rs/compare/v1.1.1...HEAD
+[0.2.0]: https://github.com/jake-low/osmx-rs/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/jake-low/osmx-rs/releases/tag/v0.1.0

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "osmx"
 description = "Rust port of OSMExpress - a fast database file format for OpenStreetMap"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["Jake Low <[email protected]>"]
 homepage = "https://github.com/jake-low/osmx-rs"
 repository = "https://github.com/jake-low/osmx-rs"

README.md

@@ -29,6 +29,18 @@ osmx-rs is not designed for reading untrusted input files. Using this crate to r
 
 Also worth noting that osmx-rs depends on the [lmdb](https://crates.io/crates/lmdb) crate, which wraps the [LMDB](https://www.symas.com/lmdb) C API and therefore requires the use of `unsafe`.
 
+## CLI command
+
+This repository also contains a CLI tool for interacting with `.osmx` files.
+
+Usage: `osmx-rs [COMMAND] [ARGS...]`
+
+Commands:
+- `expand`: convert an OSM PBF file to an OSMX database
+- `stat`: print statistics about the contents of an OSMX database
+
+The command is intended to be useful tool, but also to be an illustrative example of how to use the `osmx-rs` crate to create and interact with `.osmx` files. The source code can be found in the `bin/` directory.
+
 ## License
 
 This code can be used under the terms of either the [MIT license](./LICENSE-MIT) or [Apache-2.0 license](./LICENSE-APACHE), at your option.