Skip to content

Commit 6615f13

Browse files
brynblackbrynblack
authored
docs: update README.md
[ci skip]
1 parent 9a76fea commit 6615f13

File tree

1 file changed

+41
-46
lines changed

1 file changed

+41
-46
lines changed

‎README.md‎

Lines changed: 41 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,50 +1,41 @@
1-
# Polykey
2-
3-
staging:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey/badges/staging/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey/commits/staging)
4-
master:[![pipeline status](https://gitlab.com/MatrixAI/open-source/Polykey/badges/master/pipeline.svg)](https://gitlab.com/MatrixAI/open-source/Polykey/commits/master)
5-
6-
Polykey is an open-source, peer-to-peer system that addresses the critical challenge in cybersecurity: the secure sharing and delegation of authority, in the form of secrets like keys, tokens, certificates, and passwords.
7-
8-
It allows users including developers, organizations, and machines—to store these secrets in encrypted vaults on their own devices, and share them directly with trusted parties.
9-
10-
All data is end-to-end encrypted, both in transit and at rest, eliminating the risk associated with third-party storage.
11-
12-
Polykey provides a command line interface, desktop and mobile GUI, and a web-based control plane for organizational management.
13-
14-
By treating secrets as tokenized authority, it offers a fresh approach to managing and delegating authority in zero-trust architectures without adding burdensome policy complexity - a pervasive issue in existing zero-trust systems.
15-
16-
Unlike complex self-hosted secrets management systems that require specialized skills and infrastructure, Polykey is installed and running directly from the end-user device.
17-
18-
It is built to automatically navigate network complexities like NAT traversal, connecting securely to other nodes without manual configuration.
19-
20-
Key features:
21-
22-
* Decentralized Encrypted Storage - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes.
23-
* Secure Peer-to-Peer Communication - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub).
24-
* Secure Computational Workflows - Share static secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure. Create dynamic (short-lived) smart-tokens with embedded policy for more sophisticated zero-trust authority verification.
1+
<div align="center">
2+
<img width="512" src="https://polykey.com/images/polykey-logotype-light-light.svg">
3+
<br>
4+
<br>
5+
<br>
6+
<img src="https://img.shields.io/github/v/tag/MatrixAI/Polykey?style=for-the-badge">
7+
<img src="https://img.shields.io/github/actions/workflow/status/MatrixAI/Polykey/release.yml?style=for-the-badge">
8+
<img src="https://img.shields.io/npm/d18m/polykey?style=for-the-badge&label=npm%20downloads&color=d02b1d">
9+
<br>
10+
<img src="https://img.shields.io/github/downloads/MatrixAI/Polykey/total?style=for-the-badge">
11+
<img src="https://img.shields.io/github/license/MatrixAI/Polykey?style=for-the-badge">
12+
</div>
13+
14+
## What is Polykey?
15+
16+
**Polykey is an open-source, peer-to-peer system** that addresses the critical challenge in cybersecurity: **the secure sharing and delegation of authority**, in the form of secrets like keys, tokens, certificates, and passwords.
17+
18+
It allows users including developers, organizations, and machines—to **store these secrets in encrypted vaults on their own devices, and share them directly with trusted parties.**
19+
20+
* **All data is end-to-end encrypted**, both in transit and at rest, eliminating the risk associated with third-party storage.
21+
* **Polykey provides a command line interface**, desktop and mobile GUI, and a web-based control plane for organizational management.
22+
* By treating secrets as tokenized authority, it offers a fresh approach to **managing and delegating authority in zero-trust architectures** without adding burdensome policy complexity - a pervasive issue in existing zero-trust systems.
23+
* Unlike complex self-hosted secrets management systems that require specialized skills and infrastructure, Polykey is **installed and running directly from the end-user device**.
24+
* It is built to **automatically navigate network complexities** like NAT traversal, connecting securely to other nodes without manual configuration.
25+
26+
**Key features:**
27+
28+
* **Decentralized Encrypted Storage** - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes.
29+
* **Secure Peer-to-Peer Communication** - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub).
30+
* **Secure Computational Workflows** - Share static secrets (passwords, keys, tokens and certificates) with people, between teams, and across machine infrastructure. Create dynamic (short-lived) smart-tokens with embedded policy for more sophisticated zero-trust authority verification.
2531
* With Polykey Enterprise, you can create private networks of Polykey nodes and apply mandatory policy governing node behaviour.
2632

27-
https://github.com/MatrixAI/Polykey/assets/640797/e35a6bf4-4c07-4f2a-a6bf-bb176b961996
28-
29-
This repository is the core library for Polykey.
30-
31-
The Polykey project is split up into these main repositories:
32-
33-
* [Polykey](https://github.com/MatrixAI/Polykey) - Polykey Core Library
34-
* [Polykey-CLI](https://github.com/MatrixAI/Polykey-CLI) - CLI of Polykey
35-
* [Polykey-Desktop](https://github.com/MatrixAI/Polykey-Desktop) - Polykey Desktop (Windows, Mac, Linux) application
36-
* [Polykey-Mobile](https://github.com/MatrixAI/Polykey-Mobile) - Polykey Mobile (iOS & Android) Application
37-
* [Polykey Enterprise](https://polykey.com) - Web Control Plane SaaS
38-
39-
Have a bug or a feature-request? Please submit it the issues of the relevant subproject above.
40-
41-
For tutorials, how-to guides, reference and theory, see the [docs](https://polykey.com/docs).
42-
43-
Have a question? Join our [discussion board](https://github.com/MatrixAI/Polykey/discussions).
44-
45-
Have a security issue you want to let us know? You can contact us on our website.
46-
47-
Our main website is https://polykey.com
33+
## Table of Contents
34+
* [Installation](#installation)
35+
* [Development](#development)
36+
* [Docs Generation](#docs-generation)
37+
* [Publishing](#publishing)
38+
* [License](#license)
4839

4940
## Installation
5041

@@ -81,7 +72,7 @@ npm run docs
8172

8273
See the docs at: https://matrixai.github.io/Polykey/
8374

84-
### Publishing to NPM
75+
### Publishing
8576

8677
```sh
8778
# npm login
@@ -91,3 +82,7 @@ npm publish --access public
9182
git push
9283
git push --tags
9384
```
85+
86+
## License
87+
88+
Polykey is licensed under the GPLv3, you may read the terms of the license [here](LICENSE).

0 commit comments

Comments
 (0)