Skip to content

Commit 8ea5786

Browse files
committed
Remove redb from documentation
1 parent 72a3616 commit 8ea5786

3 files changed

Lines changed: 18 additions & 14 deletions

File tree

README.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,17 +30,24 @@ reaching full support of FIX 4.4 and 5.0 workflows as soon as possible.
3030
### Features & status
3131

3232
- [x] Network layer including TCP transport with optional TLS support using `rustls`
33-
- [x] Message encoding and decoding (FIX 4.4)
33+
- [x] Message encoding and decoding
3434
- [x] Session-layer supporting the core flows, such as logins, resends, etc.
3535
- [x] Built-in message stores
3636
- [x] in-memory
3737
- [x] file-system
3838
- [x] [mongodb](https://www.mongodb.com/docs/drivers/rust/current/)
39-
- [x] [redb](https://www.redb.org/)
4039
- [x] Code-generation for FIX fields from XML specifications
41-
- [ ] FIX 5.0 support
40+
- [x] Web API and CLI for session monitoring and management
4241
- [ ] Code-generation for complete FIX messages from XML specification
4342

43+
### FIX version support
44+
45+
| Version | Status |
46+
|---------|--------|
47+
| FIX 4.2 | Should work, but currently untested |
48+
| FIX 4.4 | Fully supported |
49+
| FIX 5.0 | Planned |
50+
4451
Check out the [examples](https://github.com/Validus-Risk-Management/hotfix/tree/main/examples)
4552
to get started.
4653

crates/hotfix/src/lib.rs

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,12 @@
88
//! ### What's working already and short-term roadmap
99
//!
1010
//! - [x] Network layer including TCP transport with optional TLS support using `rustls`
11-
//! - [x] Message encoding and decoding (FIX 4.4)
11+
//! - [x] Message encoding and decoding
1212
//! - [x] Session-layer supporting the core flows, such as logins, resends, etc.
13-
//! - [x] Built-in message stores
14-
//! - [x] in-memory
15-
//! - [x] [mongodb](https://www.mongodb.com/docs/drivers/rust/current/)
16-
//! - [x] [redb](https://www.redb.org/)
17-
//! - [x] Code-generation for FIX fields from XML specifications
18-
//! - [ ] FIX 5.0 support
19-
//! - [ ] Code-generation for complete FIX messages from XML specification
13+
//! - [x] Built-in message stores (in-memory, file-system, MongoDB)
14+
//! - [x] Code-generation for FIX fields from XML specifications
15+
//! - [x] Web API and CLI for session monitoring and management
16+
//! - [ ] Code-generation for complete FIX messages from XML specification
2017
//!
2118
//! Check out the [examples](https://github.com/Validus-Risk-Management/hotfix/tree/main/examples)
2219
//! to get started.

examples/simple-new-order/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ RUST_LOG=info,hotfix=debug
3030

3131
## Message store selection
3232

33-
You can run this example with either a `redb` message store, which
34-
requires no setup. This creates the `session.db` file in the working
35-
directory to hold state.
33+
By default, this example uses the file-system message store, which
34+
requires no setup. Message state is persisted to files in the working
35+
directory.
3636

3737
Alternatively, you can try out the MongoDB store. This requires you to
3838
spin up MongoDB locally first using the provided `docker-compose` file.

0 commit comments

Comments
 (0)