aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--README.md3
-rw-r--r--log_db/src/forward_log_reader.rs2
-rw-r--r--log_db/src/reverse_log_reader.rs2
3 files changed, 5 insertions, 2 deletions
diff --git a/README.md b/README.md
index 9ec2def..01211a8 100644
--- a/README.md
+++ b/README.md
@@ -37,6 +37,8 @@ Add LogDB as a dependency in your `Cargo.toml`.
log_db = { git = "https://github.com/jantuomi/log_db.git" }
```
+Then use it in your code like so:
+
```rust
use log_db::*;
@@ -86,6 +88,7 @@ To build the Python bindings, run:
cd py_bindings
python -m venv venv
. venv/bin/activate
+pip install maturin
maturin develop # for the development version, or
maturin build --release # for the release version
```
diff --git a/log_db/src/forward_log_reader.rs b/log_db/src/forward_log_reader.rs
index 10788a7..03726d0 100644
--- a/log_db/src/forward_log_reader.rs
+++ b/log_db/src/forward_log_reader.rs
@@ -88,7 +88,7 @@ impl Iterator for ForwardLogReader<'_> {
}
#[cfg(test)]
-mod reverse_reader_tests {
+mod tests {
use super::*;
use std::path::Path;
diff --git a/log_db/src/reverse_log_reader.rs b/log_db/src/reverse_log_reader.rs
index 5d80dba..f042406 100644
--- a/log_db/src/reverse_log_reader.rs
+++ b/log_db/src/reverse_log_reader.rs
@@ -194,7 +194,7 @@ impl<'a> ReverseLogReader<'a> {
}
#[cfg(test)]
-mod reverse_reader_tests {
+mod tests {
use super::*;
use std::io::Write;
use std::path::Path;