Skip to content

Commit ca271be

Browse files
author
Ignacio Corderi
committed
Change some phrasings
1 parent 1ea9528 commit ca271be

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,25 +12,34 @@ The quicket way to get the current nightly build is to run:
1212

1313
If you want other installation options, visit the official [install](http://www.rust-lang.org/install.html) guide.
1414

15+
1516
### Adding the Kinetic-rust dependency
16-
If you want to use the latest stable [crate](https://crates.io/crates/kinetic-rust) version available at [crates.io](https://crates.io/) add this to your `Cargo.toml`:
17+
18+
If you are using [Cargo](http://doc.crates.io/index.html) and want to use the latest stable Kinetic-rust [crate](https://crates.io/crates/kinetic-rust) available at [crates.io](https://crates.io/) add this to your `Cargo.toml`:
19+
1720
```toml
1821
[dependencies.kinetic-rust]
1922
```
20-
If you are using [Cargo](http://doc.crates.io/index.html) and want the dependency to be linked directly to the GitHub repo then add this instead:
23+
24+
To get the dependency to be linked directly to the GitHub repo then add this instead:
25+
2126
```toml
2227
[dependencies.kinetic-rust]
23-
git = "https://github.com/icorderi/kinetic-rust.git"
28+
git = "https://github.com/icorderi/kinetic-rust.git"
2429
```
30+
2531
_Note: For more information on handling [dependencies](http://doc.crates.io/guide.html#adding-dependencies) check the official cargo site._
2632

2733

2834
### Importing Kinetic-rust
35+
2936
To import Kinetic-rust from your code add this statement:
37+
3038
```rust
3139
extern crate kinetic; // depend on the kinetic-rust library
3240
```
3341

42+
3443
### [Optional] Installing Kinetic-rust from source
3544

3645
git clone https://github.com/icorderi/kinetic-rust.git
@@ -48,15 +57,19 @@ The local HTML documentation will be available at `./target/doc/kinetic/index.ht
4857

4958
_Note: Some tests will require you to have a Kinetic device available. You can use the [simulator](https://github.com/seagate/kinetic-java) if you don't have real devices._
5059

60+
5161
## Documentation
5262

5363
If you need help don't forget to checkout the online [documentation](http://icorderi.github.io/kinetic-rust/doc/kinetic/) for the library.
5464

65+
5566
## Contributing
5667

5768
Get involved with the [issues](https://github.com/icorderi/kinetic-rust/issues) or submit a [PR](https://github.com/icorderi/kinetic-rust/pulls).
5869

70+
5971
## License
72+
6073
This project is licensed under The MIT License (MIT)
6174
* [Markdown](LICENSE/mit.md) version
6275
* [Original](LICENSE/mit.txt) version

0 commit comments

Comments
 (0)