hardcoresushi
/
async-psec
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

README update after publishing

This commit is contained in:
Matéo Duparc 2021-05-19 12:31:17 +02:00
parent 3944105d72
commit 151ea8222d
Signed by: hardcoresushi
GPG Key ID: 007F84120107191E
2 changed files with 5 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -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: To add this crate to your project, add the following to your project's Cargo.toml:
```toml ```toml
[dependencies] [dependencies]
async-psec = { version = "0.2", git = "https://forge.chapril.org/hardcoresushi/async-psec" } async-psec = "0.2"
``` ```
# Documentation # Documentation
The API documentation can be build by running: The API documentation can be found [here](https://docs.rs/async-psec).
```
cargo doc --all-features
```

6
src/lib.rs
View File

@ -6,7 +6,7 @@ PSEC (Peer-to-peer Secure Ephemeral Communications) is a simplification/adaptati
Add this in your `Cargo.toml`: Add this in your `Cargo.toml`:
```toml ```toml
[dependencies] [dependencies]
async-psec = "0.1" async-psec = "0.2"
``` ```
And then: And then:
```no_run ```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: If you want to split the [`Session`] struct in two parts, you must enable the `split` feature:
```toml ```toml
[dependencies] [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. 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); let large_msg = "a".repeat(5000);
assert_eq!(pad(large_msg.as_bytes(), true).len(), 8000); assert_eq!(pad(large_msg.as_bytes(), true).len(), 8000);
} }
} }