Skip to content

Commit 04a2de5

Browse files
committed
doc: update README
1 parent a1b3c4c commit 04a2de5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,29 +8,29 @@ Secure Frame (SFrame)
88
![maintenance](https://img.shields.io/maintenance/yes/2023)
99

1010

11-
This library is an implementation of [draft-ietf-sframe-enc-latest](https://sframe-wg.github.io/sframe/draft-ietf-sframe-enc.html) and provides and end-to-end encryption mechanism for media frames that is suited for WebRTC conferences.
11+
This library is an implementation of [draft-ietf-sframe-enc-03](https://datatracker.ietf.org/doc/html/draft-ietf-sframe-enc-03) and provides and end-to-end encryption mechanism for media frames that is suited for WebRTC conferences.
1212
It is in it's current form a subset of the specification.
1313
There is an alternative implementation under [goto-opensource/secure-frame-ts](https://github.com/goto-opensource/secure-frame-ts)
1414

1515
## Differences from the sframe draft
1616
* ratcheting is not implemented
1717
* keyIds are used as senderIds
18-
* no metadata authentication
18+
* no metadata authentication
1919

2020
## Supported crypto libraries
2121
Currently two crypto libraries are supported:
22-
- [ring](https://crates.io/crates/ring)
22+
- [ring](https://crates.io/crates/ring)
2323
- is enabled per default with the feature `ring`
2424
- supports compilation to Wasm32
2525
- Aes-CTR mode ciphers are not supported
2626
- [openssl](https://crates.io/crates/openssl)
2727
- is enabled with the feature `openssl`
2828
- To build e.g. use `cargo build --features openssl --no-default-features`
2929
- uses rust bindings to OpenSSL.
30-
- Per default the OpenSSL library is locally compiled and then statically linked. The build process requires a C compiler, `perl` (and `perl-core`), and `make`. For further options see the [openssl crate documentation](https://docs.rs/openssl/0.10.55/openssl/).
30+
- Per default the OpenSSL library is locally compiled and then statically linked. The build process requires a C compiler, `perl` (and `perl-core`), and `make`. For further options see the [openssl crate documentation](https://docs.rs/openssl/0.10.55/openssl/).
3131
- Compilation to Wasm32 is [not yet supported](https://github.com/sfackler/rust-openssl/issues/1016)
3232

33-
Both cannot be enabled at the same time, thus on conflict `sframe` issues a compiler error.
33+
Both cannot be enabled at the same time, thus on conflict `sframe` issues a compiler error.
3434
## License
3535
Licensed under either of Apache License, Version 2.0 or MIT license at your option.
3636

@@ -39,4 +39,4 @@ Unless you explicitly state otherwise, any contribution intentionally submitted
3939
## Contribution
4040
Any help in form of descriptive and friendly issues or comprehensive pull requests are welcome!
4141

42-
The Changelog of this library is generated from its commit log, there any commit message must conform with https://www.conventionalcommits.org/en/v1.0.0/. For simplicity you could make your commits with convco.
42+
The Changelog of this library is generated from its commit log, there any commit message must conform with https://www.conventionalcommits.org/en/v1.0.0/. For simplicity you could make your commits with convco.

0 commit comments

Comments
 (0)