Skip to content

Commit 3e284c6

Browse files
Merge pull request #1 from paulhowardarm/phREADME
README enhancements and new visual styling
2 parents 430ba62 + e79150e commit 3e284c6

File tree

5 files changed

+63
-9
lines changed

5 files changed

+63
-9
lines changed

PARTNERS.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
-- Copyright (c) 2019, Arm Limited, All Rights Reserved
3+
-- SPDX-License-Identifier: Apache-2.0
4+
--
5+
-- Licensed under the Apache License, Version 2.0 (the "License"); you may
6+
-- not use this file except in compliance with the License.
7+
-- You may obtain a copy of the License at
8+
--
9+
-- http://www.apache.org/licenses/LICENSE-2.0
10+
--
11+
-- Unless required by applicable law or agreed to in writing, software
12+
-- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13+
-- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14+
-- See the License for the specific language governing permissions and
15+
-- limitations under the License.
16+
--->
17+
18+
# Contributing Organizations
19+
20+
(To appear here)
21+
22+
# Adopters and Industry Partners
23+
24+
(To appear here)

README.md

Lines changed: 39 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,49 @@
1616
--->
1717

1818
<p align="center">
19-
<img src="https://github.com/parallaxsecond/parsec/blob/master/parsec.png?raw=true" alt="Parsec logo"/>
19+
<img src="./doc/images/parsec/ARM1007_PARSEC Logo_ST2_RGB_Stacked_Colour.png" alt="Parsec logo"/>
2020
<br><br>
2121
<a href="https://github.com/parallaxsecond/parsec/actions?query=workflow%3A%22Continuous+Integration%22"><img src="https://github.com/parallaxsecond/parsec/workflows/Continuous%20Integration/badge.svg" alt="CI tests"/></a>
2222
<a href="https://travis-ci.com/parallaxsecond/parsec"><img src="https://travis-ci.com/parallaxsecond/parsec.svg?branch=master" alt="Travis CI tests"/></a>
2323
<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License"/></a>
2424
</p>
2525

26-
**Parsec** is the **P**latform **A**bst**R**action for **SEC**urity, a new open-source initiative
27-
to provide a common API to secure services in a platform-agnostic way.
26+
# Welcome To PARSEC
2827

29-
Read the Parsec documentation [online](https://parallaxsecond.github.io/parsec-book/)!
28+
**PARSEC** is the **P**latform **A**bst**R**action for **SEC**urity, a new open-source initiative
29+
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

31-
## Disclaimer
31+
<p align="center">
32+
<img src="./doc/images/parsec/ParsecConceptDiagram.png" alt="Parsec Concept Diagram"/>
33+
</p>
34+
35+
Read the Parsec documentation [online](https://parallaxsecond.github.io/parsec-book/).
36+
37+
Read the whitepaper [Security for the Infrastructure Edge](https://www.arm.com/-/media/global/people/Security-For-The-Infrastructure-Edge-White-paper-NDA).
38+
39+
**Note**: Arm is contributing to Parsec as part of [Project Cassini](https://www.arm.com/-/media/global/solutions/artificial-intelligence/Project_Cassini.pdf).
40+
41+
# Why PARSEC?
42+
43+
Use Parsec when you need:
44+
45+
- A **portable interface to your platform's Root of Trust** in order to manage keys and perform cryptographic operations without knowledge of the hardware.
46+
- A simple and portable way to access the **best available security** of your platform in your **preferred programming language**.
47+
48+
# What PARSEC Provides
49+
50+
The value proposition of Parsec is that it provides the following:
51+
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)
53+
- **Mediation** – security as a microservice, brokering access to the hardware and providing isolated key stores in a multi-tenant environment
54+
- **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”
55+
- **Openness** – an open-source project inviting contributions to enhance the ecosystem both within the service and among its client libraries
56+
57+
# Partner Organizations
58+
59+
See who is [using and contributing to PARSEC](./PARTNERS.md).
60+
61+
# Disclaimer
3262

3363
Parsec is a new open source project and is under development. This code repository is being made
3464
available so that the developer community can learn and give feedback about the new interfaces and the concepts of platform-agnostic security.
@@ -38,7 +68,7 @@ suitable for use in production. Documentation pages may be incomplete and are su
3868
without notice. Interfaces may change in such a way as to break compatibility with client code.
3969
Contributions from the developer community are welcome. Please refer to the contribution guidelines.
4070

41-
## Example
71+
# Example
4272

4373
Launch the Parsec service with Mbed Crypto as the only provider (using the default configuration):
4474
```bash
@@ -62,7 +92,7 @@ let signature = client.sign(key_name,
6292

6393
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!
6494

65-
## Community channel and meetings
95+
# Community Channel and Meetings
6696

6797
Come and talk to us in [our Slack channel](https://app.slack.com/client/T0JK1PCN6/CPMQ9D4H1)!
6898
[Here](http://dockr.ly/slack) is how to join the workspace.
@@ -72,14 +102,14 @@ with Parsec maintainers and community members.
72102
The meeting is open to the public and everyone is encouraged to attend. We will use the time to
73103
discuss features, integrations, issues, and roadmap. We look forward to seeing you all.
74104

75-
## Contributing
105+
# Contributing
76106

77107
We would be happy for you to contribute to Parsec! Check the [**Contributing**](CONTRIBUTING.md)
78108
file to know more about the contribution process.
79109
Check the [open issues](https://github.com/orgs/parallaxsecond/projects/1) on the board if you
80110
need any ideas 🙂!
81111

82-
## License
112+
# License
83113

84114
The software is provided under Apache-2.0. Contributions to this project are accepted under the same license.
85115

Loading
429 KB
Loading
4.14 KB
Loading

0 commit comments

Comments
 (0)