Skip to content

Commit caeb021

Browse files
committed
[Rust] Fix some grammar in README.md
1 parent bb8270f commit caeb021

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

rust/README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ Official Rust bindings for [Binary Ninja].
1111

1212
These bindings are still actively under development. Compatibility _will_ break and conventions _will_ change!
1313
It is encouraged that you reference a specific commit to avoid having your plugin/application break when the API changes.
14-
To specify a specific commit see the cargo documentation [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choice-of-commit).
14+
To specify a specific commit, see the cargo documentation [here](https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#choice-of-commit).
1515

16-
If you are worried about breaking changes avoid modules with warnings about instability!
16+
If you are worried about breaking changes, avoid modules with warnings about instability!
1717

1818
**MSRV**: The Rust version specified in the `Cargo.toml`.
1919

@@ -53,7 +53,7 @@ More examples can be found in [here](https://github.com/Vector35/binaryninja-api
5353
### Link to Binary Ninja
5454

5555
Writing a standalone executable _or_ a plugin requires that you link to `binaryninjacore` directly. The process of locating that however
56-
is done for you within the `binaryninjacore-sys` crate. Because linker arguments are _not_ transitive for executables you
56+
is done for you within the `binaryninjacore-sys` crate. Because linker arguments are _not_ transitive for executables, you
5757
must specify them within your `build.rs`.
5858

5959
`Cargo.toml`:
@@ -109,7 +109,7 @@ Examples for writing a plugin can be found [here](https://github.com/Vector35/bi
109109

110110
### Write a Standalone Executable
111111

112-
If you have a headless supporting license you are able to use Binary Ninja as a regular dynamically loaded library.
112+
If you have a headless supporting license, you are able to use Binary Ninja as a regular dynamically loaded library.
113113

114114
Standalone executables must initialize the core themselves. `binaryninja::headless::init()` to initialize the core, and
115115
`binaryninja::headless::shutdown()` to shutdown the core. Prefer using `binaryninja::headless::Session` as it will
@@ -140,14 +140,14 @@ If you're thinking of contributing to the Rust API, we encourage you to join the
140140

141141
### Testing
142142

143-
When contributing new APIs or refactoring existing APIs it is vital that you test your code! If you do not have a
144-
headless supported license you should still be able to write them and open your PR. Once open a
143+
When contributing new APIs or refactoring existing APIs, it is vital that you test your code! If you do not have a
144+
headless supported license, you should still be able to write them and open your PR. Once open, a
145145
maintainer will approve tests to run and from there you can refine the test so that it passes in CI.
146146

147147
### Documentation
148148

149-
When refactoring or making new changes make sure that the documentation for the respective APIs is up-to-date and not missing.
150-
Much of the APIs documentation exists only in the python bindings, so use that as a guide. If there is an API that confuses you
149+
When refactoring or making new changes, make sure that the documentation for the respective APIs is up to date and not missing.
150+
Much of the APIs documentation exists only in the python bindings, so use that as a guide. If there is an API that confuses you,
151151
it will likely confuse someone else, and you should make an issue or ask for guidance in the Slack channel above.
152152

153153
---
@@ -158,11 +158,14 @@ This project makes use of:
158158
- [log] ([log license] - MIT)
159159
- [rayon] ([rayon license] - MIT)
160160
- [thiserror] ([thiserror license] - MIT)
161+
- [serde_json] ([serde_json license] - MIT)
161162

162163
[log]: https://github.com/rust-lang/log
163164
[log license]: https://github.com/rust-lang/log/blob/master/LICENSE-MIT
164165
[rayon]: https://github.com/rayon-rs/rayon
165166
[rayon license]: https://github.com/rayon-rs/rayon/blob/master/LICENSE-MIT
166167
[thiserror]: https://github.com/dtolnay/thiserror
167168
[thiserror license]: https://github.com/dtolnay/thiserror/blob/master/LICENSE-MIT
169+
[serde_json]: https://github.com/serde-rs/json
170+
[serde_json license]: https://github.com/serde-rs/json/blob/master/LICENSE-MIT
168171
[Binary Ninja]: https://binary.ninja

0 commit comments

Comments
 (0)