Skip to content

Commit 8c3f776

Browse files
committed
misc: updated README.MD crate version and fixed example syntax [ci-skip]
1 parent 6207f58 commit 8c3f776

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.MD

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,27 +3,30 @@
33
[license: gpl v3]: https://img.shields.io/badge/License-GPLv3-blue.svg
44
[latest version]: https://img.shields.io/crates/v/bmatcher.svg
55
[crates.io]: https://crates.io/crates/bmatcher
6-
[github build status]: https://github.com/WolverinDEV/bmatcher/workflows/Rust/badge.svg?branch=master
7-
[actions]: https://github.com/WolverinDEV/bmatcher/actions?query=workflow%3ARust
6+
[github build status]: https://github.com/WolverinDEV/bmatcher/actions/workflows/rust.yml/badge.svg?branch=master
7+
[actions]: https://github.com/WolverinDEV/bmatcher/actions/workflows/rust.yml
88

99
`bmatcher` is a flexible and efficient binary pattern matching library designed to help you search and match binary data.
1010

1111
## Motivation
1212

13-
Reverse engineering is challenging. When you identify an interesting address, such as a function or global variable, you don't want to lose all that effort when the program is updated.
13+
Reverse engineering is challenging.
14+
When you identify an interesting address, such as a function or global variable, you don't want to lose all that effort when the program is updated.
1415

15-
The good news is that, during updates, programs usually don't change drastically. While some functions and data may be altered, much of the program remains unchanged. However, this means that the unchanged parts might be moved to different addresses.
16+
The good news is that, during updates, programs usually don't change drastically. While some functions and data may be altered, much of the program remains unchanged.
17+
However, this means that the unchanged parts might be moved to different addresses.
1618

1719
This is where patterns come in.
18-
Patterns allow you to track these interesting parts of a program, even as it evolves and updates. By using patterns, you can identify specific functions, data references, or other critical locations, regardless of where they end up after a program update.
20+
Patterns allow you to track these interesting parts of a program, even as it evolves and updates.
21+
By using patterns, you can identify specific functions, data references, or other critical locations, regardless of where they end up after a program update.
1922

2023
## Getting Started
2124

2225
To use `bmatcher`, add it as a dependency in your `Cargo.toml`:
2326

2427
```toml
2528
[dependencies]
26-
bmatcher = "0.1"
29+
bmatcher = "0.3"
2730
```
2831

2932
## Creating a pattern
@@ -51,7 +54,7 @@ let pattern = pattern!("
5154
E9 [4]
5255
");
5356

54-
let mut matcher = BinaryMatcher::new(&pattern, &data);
57+
let mut matcher = bmatcher::execute(&data, &pattern);
5558
let Some(match_stack) = matcher.next_match() else {
5659
panic!("failed to find pattern");
5760
};

0 commit comments

Comments
 (0)