Skip to content

Commit 863eec1

Browse files
Merge pull request #141 from paulhowardarm/master
A few more README updates including fixes for broken doc links Signed-off-by: Paul Howard <paul.howard@arm.com>
2 parents 127b7ca + 0b8e3da commit 863eec1

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

PARTNERS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919

2020
(To appear here)
2121

22+
**Note**: Arm is contributing to Parsec as part of [Project Cassini](https://www.arm.com/-/media/global/solutions/artificial-intelligence/Project_Cassini.pdf).
23+
2224
# Adopters and Industry Partners
2325

2426
(To appear here)

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,17 @@
2525

2626
# Welcome To PARSEC
2727

28-
**PARSEC** is the **P**latform **A**bst**R**action for **SEC**urity, a new open-source initiative
28+
**PARSEC** is the **P**latform **A**bst**R**action for **SEC**urity, an open-source initiative
2929
to provide a common API to hardware security and cryptographic services in a platform-agnostic way. This abstraction layer keeps workloads decoupled from physical platform details, enabling cloud-native delivery flows within the data center and at the edge.
3030

3131
<p align="center">
3232
<img src="./doc/images/parsec/ParsecConceptDiagram.png" alt="Parsec Concept Diagram"/>
3333
</p>
3434

35-
Read the Parsec documentation [online](https://parallaxsecond.github.io/parsec-book/).
35+
Read the Parsec documentation [**online**](https://parallaxsecond.github.io/parsec-book/).
3636

37-
Read the whitepaper [Security for the Infrastructure Edge](https://www.arm.com/-/media/global/people/Security-For-The-Infrastructure-Edge-White-paper-NDA).
37+
Read the whitepaper [**Security for the Infrastructure Edge**](https://www.arm.com/-/media/global/people/Security-For-The-Infrastructure-Edge-White-paper-NDA).
3838

39-
**Note**: Arm is contributing to Parsec as part of [Project Cassini](https://www.arm.com/-/media/global/solutions/artificial-intelligence/Project_Cassini.pdf).
4039

4140
# Why PARSEC?
4241

@@ -49,18 +48,22 @@ Use Parsec when you need:
4948

5049
The value proposition of Parsec is that it provides the following:
5150

52-
- **Abstraction** – a common API that is truly agnostic and based on modern cryptographic principles, grounded in the [Platform Security Architecture](https://www.arm.com/why-arm/architecture/platform-security-architecture)
51+
- **Abstraction** – a common API that is truly agnostic and based on modern cryptographic principles
5352
- **Mediation** – security as a microservice, brokering access to the hardware and providing isolated key stores in a multi-tenant environment
5453
- **Ergonomics** – a client library ecosystem that brings the API to the fingertips of developers in any programming language: “easy to consume, hard to get wrong”
5554
- **Openness** – an open-source project inviting contributions to enhance the ecosystem both within the service and among its client libraries
5655

56+
# Maintainers
57+
58+
PARSEC is a collaborative project. The current list of the individuals and organizations who maintain this project can be found [**here**](./MAINTAINERS.toml).
59+
5760
# Partner Organizations
5861

59-
See who is [using and contributing to PARSEC](./PARTNERS.md).
62+
See who is [**using and contributing to PARSEC**](./PARTNERS.md).
6063

6164
# Disclaimer
6265

63-
Parsec is a new open source project and is under development. This code repository is being made
66+
Parsec is a new open source project and is under active development. This code repository is being made
6467
available so that the developer community can learn and give feedback about the new interfaces and the concepts of platform-agnostic security.
6568
The implementation that is provided is suitable for exploratory testing and experimentation only.
6669
This test implementation does not offer any tangible security benefits and therefore is not
@@ -70,7 +73,7 @@ Contributions from the developer community are welcome. Please refer to the cont
7073

7174
# Example
7275

73-
Launch the Parsec service with Mbed Crypto as the only provider (using the default configuration):
76+
Launch the Parsec service with a single software-based provider (using the default configuration):
7477
```bash
7578
$ git clone https://github.com/parallaxsecond/parsec.git
7679
$ cd parsec
@@ -90,12 +93,12 @@ let signature = client.sign(key_name,
9093
.unwrap();
9194
```
9295

93-
Check the [user](https://parallaxsecond.github.io/parsec-book/user_guides/) and [developer](https://parallaxsecond.github.io/parsec-book/dev_guides/) guides for more info on building, installing, testing and using Parsec!
96+
Check the [**user**](https://parallaxsecond.github.io/parsec-book/parsec_users.html), [**client developer**](https://parallaxsecond.github.io/parsec-book/parsec_client/index.html) and [**service developer**](https://parallaxsecond.github.io/parsec-book/parsec_service/index.html) guides for more information on building, installing, testing and using Parsec!
9497

9598
# Community Channel and Meetings
9699

97-
Come and talk to us in [our Slack channel](https://app.slack.com/client/T0JK1PCN6/CPMQ9D4H1)!
98-
[Here](http://dockr.ly/slack) is how to join the workspace.
100+
Come and talk to us in our[**Slack channel**](https://app.slack.com/client/T0JK1PCN6/CPMQ9D4H1)!
101+
[**Here**](http://dockr.ly/slack) is how to join the workspace.
99102

100103
Also join the [**biweekly meeting**](https://calendar.google.com/calendar?cid=ZG9ja2VyLmNvbV9xcHAzbzl2aXBhbmE0NGllcmV1MjlvcHZkNEBncm91cC5jYWxlbmRhci5nb29nbGUuY29t)
101104
with Parsec maintainers and community members.
@@ -105,8 +108,7 @@ discuss features, integrations, issues, and roadmap. We look forward to seeing y
105108
# Contributing
106109

107110
We would be happy for you to contribute to Parsec! Check the [**Contributing**](CONTRIBUTING.md)
108-
file to know more about the contribution process. For a list of current contributors, check [here](CONTRIBUTORS.md).
109-
Check the [open issues](https://github.com/orgs/parallaxsecond/projects/1) on the board if you
111+
file to know more about the contribution process. For a list of current contributors, check [**here**](CONTRIBUTORS.md). Check the [**open issues**](https://github.com/orgs/parallaxsecond/projects/1) on the board if you
110112
need any ideas 🙂!
111113

112114
# License
@@ -141,4 +143,4 @@ This project uses the following third party crates:
141143
* version (MIT and Apache-2.0)
142144

143145
This project uses the following third party libraries:
144-
* [Mbed Crypto](https://github.com/ARMmbed/mbed-crypto) (Apache-2.0)
146+
* [**Mbed Crypto**](https://github.com/ARMmbed/mbed-crypto) (Apache-2.0)

0 commit comments

Comments
 (0)