Skip to content

Commit 962f075

Browse files
committed
Added benchmarks and bumped to v0.4.0
1 parent e3a0a37 commit 962f075

File tree

5 files changed

+17
-4
lines changed

5 files changed

+17
-4
lines changed

Cargo.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "lemmeknow"
3-
version = "0.3.0"
3+
version = "0.4.0"
44
edition = "2021"
55
authors = ["swanandx"]
66
description = "Identify any mysterious text or analyze strings from a file"

README.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -116,22 +116,35 @@ Want to use this as a crate in your project? or make a web api for it? No worrie
116116

117117
```toml
118118
[dependencies]
119-
lemmeknow = "0.3.0"
119+
lemmeknow = { version = "0.4.0", default-features = false }
120120

121121
```
122122

123123
OR
124124

125125
```toml
126126
[dependencies]
127-
lemmeknow = { git = "https://github.com/swanandx/lemmeknow" }
127+
lemmeknow = { git = "https://github.com/swanandx/lemmeknow", default-features = false }
128128

129129
```
130130

131131
> Refer to [documentation](https://docs.rs/lemmeknow) for more info.
132132
133133
<br />
134134

135+
## ⚔️ Benchmarks
136+
137+
lemmeknow is around **33x faster** than pywhat for a file of 8.7MB, and it is **3x faster** for a single string!
138+
139+
| A file of 8.7MB | A single string |
140+
| --- | --- |
141+
| *Summary*: `lemmeknow.exe floss.exe` ran **33.13 ± 9.74** times faster than `what floss.exe` | *Summary*: `lemmeknow.exe 3FZ..Zc5` ran **3.29 ± 0.77** times faster than `pywhat 3FZ..Zc5` |
142+
| ![File benchmark](images/bench_file.png) | ![String benchmark](images/bench_string.png) |
143+
144+
> Thanks to [SkeletalDemise](https://github.com/SkeletalDemise) for the benchmarks and the whisker plots ✨
145+
146+
<br />
147+
135148
## 🚧 Contributing
136149

137150
You can contribute by adding new regex, improving current regex, improving code performance or fixing minor bugs! Just open a issue or submit a PR.

images/bench_file.png

21.2 KB
Loading

images/bench_string.png

28.5 KB
Loading

src/lib.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
*
1010
* ```toml
1111
* [dependencies]
12-
* lemmeknow = { version = "0.3.0", default-features = false }
12+
* lemmeknow = { version = "0.4.0", default-features = false }
1313
* ```
1414
*
1515
* OR by using github repositoy:

0 commit comments

Comments
 (0)