README update after publishing
This commit is contained in:
parent
3944105d72
commit
151ea8222d
@ -30,11 +30,8 @@ async fn main() -> Result<(), PsecError> {
|
||||
To add this crate to your project, add the following to your project's Cargo.toml:
|
||||
```toml
|
||||
[dependencies]
|
||||
async-psec = { version = "0.2", git = "https://forge.chapril.org/hardcoresushi/async-psec" }
|
||||
async-psec = "0.2"
|
||||
```
|
||||
|
||||
# Documentation
|
||||
The API documentation can be build by running:
|
||||
```
|
||||
cargo doc --all-features
|
||||
```
|
||||
The API documentation can be found [here](https://docs.rs/async-psec).
|
||||
|
@ -6,7 +6,7 @@ PSEC (Peer-to-peer Secure Ephemeral Communications) is a simplification/adaptati
|
||||
Add this in your `Cargo.toml`:
|
||||
```toml
|
||||
[dependencies]
|
||||
async-psec = "0.1"
|
||||
async-psec = "0.2"
|
||||
```
|
||||
And then:
|
||||
```no_run
|
||||
@ -36,7 +36,7 @@ async fn main() -> Result<(), PsecError> {
|
||||
If you want to split the [`Session`] struct in two parts, you must enable the `split` feature:
|
||||
```toml
|
||||
[dependencies]
|
||||
async-psec = { version = "0.1", feature = ["split"] }
|
||||
async-psec = { version = "0.2", feature = ["split"] }
|
||||
```
|
||||
This can be useful if you want to send data from one thread/task and receive from another in parallel.
|
||||
*/
|
||||
@ -699,4 +699,4 @@ mod tests {
|
||||
let large_msg = "a".repeat(5000);
|
||||
assert_eq!(pad(large_msg.as_bytes(), true).len(), 8000);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user