diff --git a/README.md b/README.md new file mode 100644 index 0000000..b3f49d8 --- /dev/null +++ b/README.md @@ -0,0 +1,30 @@ +## `rsbag` + +### `rsbag` library +Parses rosbags using nom parser combinators and rayon for parallelism + +### `bag_info` example +Run using +```bash +cargo run --example bag_info -- +``` + +Similar to `rosbag info ` + +### `mongobag` example +Run using +```bash +cargo run --example mongobag -- +``` + +Exports a bag to a mongodb database. Assumes it is hosted locally on the default port, if not you can adjust the connection string in the code. + + +### `rsbag_arrow` +Run using +```bash +cargo run -p rsbag_arrow --release -- +``` + +Exports a bag to parquet files using arrow. The output directory will contain a parquet file for each topic in the bag. +