Skip to content

Commit

Permalink
Merge pull request openmls#1651 from openmls/raphael/update-links
Browse files Browse the repository at this point in the history
Update links
  • Loading branch information
franziskuskiefer authored Sep 3, 2024
2 parents 72c9d10 + 45bdb58 commit b9ebd9f
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 15 deletions.
4 changes: 2 additions & 2 deletions Developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,5 +35,5 @@ You can start by looking at the [open issues](https://github.com/openmls/openmls

OpenMLS adheres to the [Contributor Covenant](https://www.contributor-covenant.org/) Code of Coduct. Please read the [Code of Conduct](https://github.com/openmls/openmls/tree/main/CODE_OF_CONDUCT.md) carefully.

[book-main-link]: https://openmls.tech/openmls/book
[docs-main-link]: https://openmls.tech/openmls/doc/openmls/index.html
[book-main-link]: https://latest.openmls.tech/book
[docs-main-link]: https://latest.openmls.tech/doc/openmls/index.html
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,14 @@
[![OpenMLS List][list-image]][list-link]

[![Tests & Checks][gh-tests-image]](https://github.com/openmls/openmls/actions/workflows/tests.yml?branch=main)
<!-- Disabled until the drone CI is fixed in #1094 [![ARM64 Build Status][drone-image]](https://cloud.drone.io/openmls/openmls) -->
[![codecov][codecov-image]](https://codecov.io/gh/openmls/openmls)

[![Docs][docs-release-badge]][docs-release-link]
[![Book][book-release-badge]][book-release-link]
![Rust Version][rustc-image]

*OpenMLS* is a Rust implementation of the Messaging Layer Security (MLS) protocol, as specified in [RFC 9420](https://datatracker.ietf.org/doc/html/rfc9420).
<!-- The introduction of the book imports the lines up until here (line 14), excluding the headline and separately the lines below (starting from line 20). If the line numbers change here, please modify the imported lines in the book.-->
<!-- The introduction of the book imports the lines up until here (line 13), excluding the headline and separately the lines below (starting from line 19, "Supported ciphersuite"). If the line numbers change here, please modify the imported lines in the book.-->

It is a software library that can serve as a building block in applications that require end-to-end encryption of messages.
It has a safe and easy-to-use interface that hides the complexity of the underlying cryptographic operations.
Expand All @@ -33,9 +32,6 @@ OpenMLS is built and tested on the Github CI for the following rust targets.
- i686-pc-windows-msvc
- x86_64-apple-darwin

<!-- Disabled until #1094 is fixed. Additionally, we're building and testing aarch64-unknown-linux-gnu on
[drone.io](https://cloud.drone.io/openmls/openmls). -->

### Unsupported, but built on CI

The Github CI also builds (but doesn't test) the following rust targets.
Expand Down Expand Up @@ -78,7 +74,7 @@ OpenMLS is maintained and developed by [Phoenix R&D] and [Cryspen].
[docs-release-badge]: https://img.shields.io/badge/docs-release-blue.svg?style=for-the-badge
[docs-release-link]: https://docs.rs/crate/openmls/latest
[book-release-badge]: https://img.shields.io/badge/book-release-blue.svg?style=for-the-badge
[book-release-link]: https://openmls.tech/book
[book-release-link]: https://book.openmls.tech
[drone-image]: https://img.shields.io/drone/build/openmls/openmls/main?label=ARM64%20Build%20Status&logo=drone&style=for-the-badge
[codecov-image]: https://img.shields.io/codecov/c/github/openmls/openmls/main?logo=codecov&style=for-the-badge
[gh-tests-image]: https://img.shields.io/github/actions/workflow/status/openmls/openmls/tests.yml?branch=main&style=for-the-badge&logo=github
Expand Down
4 changes: 2 additions & 2 deletions book/src/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

<!-- Get the Readme without the headline until (including) the introductory sentence -->

{{#include ../../README.md:2:14}}
{{#include ../../README.md:2:13}}
OpenMLS provides a high-level API to create and manage MLS groups. It supports basic ciphersuites and an interchangeable cryptographic provider, key store, and random number generator.

This book provides guidance on using OpenMLS and its `MlsGroup` API to perform basic group operations, illustrated with examples.

<!-- Get the rest of the Readme -->

{{#include ../../README.md:20:}}
{{#include ../../README.md:19:}}
2 changes: 1 addition & 1 deletion openmls/src/group/mls_group/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ impl MlsGroupJoinConfig {
}

/// Specifies configuration for the creation of an [`MlsGroup`]. Refer to the
/// [User Manual](https://openmls.tech/book/user_manual/group_config.html) for
/// [User Manual](https://book.openmls.tech/user_manual/group_config.html) for
/// more information about the different configuration values.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct MlsGroupCreateConfig {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! This module tests the validation of commits as defined in
//! https://openmls.tech/book/message_validation.html#commit-message-validation
//! https://book.openmls.tech/message_validation.html#commit-message-validation
use create_commit::CreateCommitParams;
use openmls_traits::{prelude::*, signatures::Signer, types::Ciphersuite};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! This module tests the validation of message framing as defined in
//! https://openmls.tech/book/message_validation.html#semantic-validation-of-message-framing
//! https://book.openmls.tech/message_validation.html#semantic-validation-of-message-framing
use openmls_traits::prelude::{openmls_types::Ciphersuite, *};
use tls_codec::{Deserialize, Serialize};
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
//! This module tests the validation of proposals as defined in
//! https://openmls.tech/book/message_validation.html#semantic-validation-of-proposals-covered-by-a-commit
//! https://book.openmls.tech/message_validation.html#semantic-validation-of-proposals-covered-by-a-commit
use crate::{storage::OpenMlsProvider, test_utils::frankenstein::*, treesync::LeafNodeParameters};
use openmls_traits::{
Expand Down
2 changes: 1 addition & 1 deletion openmls/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@
//! ```
//!
//! [//]: # "links and badges"
//! [user Manual]: https://openmls.tech/book
//! [user Manual]: https://book.openmls.tech
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(not(test), forbid(unsafe_code))]
#![cfg_attr(not(feature = "test-utils"), deny(missing_docs))]
Expand Down

0 comments on commit b9ebd9f

Please sign in to comment.