Skip to content
This repository was archived by the owner on Sep 1, 2021. It is now read-only.

Commit b6ca780

Browse files
committed
[wrapper] update README to reflect recent changes of the original bindings crate.
1 parent ef18ef3 commit b6ca780

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
@@ -1,18 +1,21 @@
11
# Dear ImGui Memory Editor
22

3-
Safe Rust bindings to the Dear ImGui memory editor widget, to be used with `imgui-rs`.
3+
Safe, Rust bindings to the Dear ImGui memory editor widget, to be used with `imgui-rs`.
44

55
## Note
66

7-
This crate is *not* published on `crates.io` since there is already
8-
a crate on `crates.io` which implements bindings to the widget with the same name.
7+
Not to be confused with the crate on `crates.io` with the same name.
98

10-
The crate on `crates.io` is outdated, and has a totally different API while
11-
this crate tries to stay close to the original widget's API.
9+
This crate is a completely different crate from the one on `crates.io` but both
10+
try to achieve the same goal, hence you can use whichever you want.
11+
12+
This crate tries to be as similar as possible to the C++ widget, while the one
13+
on `crates.io` has a bit of a different API.
1214

1315
## Usage
1416

15-
You can use this crate by adding the following in your `Cargo.toml`
17+
Since the crate is not available on `crates.io`, you cannot directly specify the version
18+
and instead must add the following to your `Cargo.toml`,
1619

1720
```toml
1821
[dependencies]
@@ -28,4 +31,4 @@ You can access the docs for this crate [here](https://nightshade256.github.io/ru
2831

2932
## License
3033

31-
Both the sys and wrapper crates are licensed under the MIT license.
34+
This project is licensed under the terms of the MIT license.

0 commit comments

Comments
 (0)