Skip to content

Commit 694c2ea

Browse files
committed
fix: format README.md to pass Prettier CI
style(docs): format README.md to satisfy Prettier CI
1 parent 7cc1060 commit 694c2ea

File tree

1 file changed

+64
-32
lines changed

1 file changed

+64
-32
lines changed

docs/README.md

Lines changed: 64 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,75 +1,107 @@
11
# **Welcome to the Polykey documentation**
22

3-
* [Tutorials:](https://polykey.com/docs/tutorials) Step-by-step guides that introduce Polykey through practical outcomes.
3+
- [Tutorials:](https://polykey.com/docs/tutorials) Step-by-step guides that
4+
introduce Polykey through practical outcomes.
45

5-
* [How-To Guides:](https://polykey.com/docs/how-to-guides) Short, targeted instructions for achieving specific use-cases, assuming prior familiarity.
6+
- [How-To Guides:](https://polykey.com/docs/how-to-guides) Short, targeted
7+
instructions for achieving specific use-cases, assuming prior familiarity.
68

7-
* [Theory:](https://polykey.com/docs/theory/) Conceptual foundations explaining the rationale behind Polykey.
9+
- [Theory:](https://polykey.com/docs/theory/) Conceptual foundations explaining
10+
the rationale behind Polykey.
811

9-
* [Reference:](https://polykey.com/docs/reference/) Lookup documentation for commands, functions, and technical specifications.
12+
- [Reference:](https://polykey.com/docs/reference/) Lookup documentation for
13+
commands, functions, and technical specifications.
1014

1115
## Introduction
1216

13-
Polykey helps individuals, teams, and software agents manage and share secrets securely and intuitively.
17+
Polykey helps individuals, teams, and software agents manage and share secrets
18+
securely and intuitively.
1419

15-
* **User-Friendly:** Designed for everyday users, with no need to be a cryptography or cybersecurity expert.
20+
- **User-Friendly:** Designed for everyday users, with no need to be a
21+
cryptography or cybersecurity expert.
1622

17-
* **Automation-Ready:** Integrates into software workflows for automated secret handling.
23+
- **Automation-Ready:** Integrates into software workflows for automated secret
24+
handling.
1825

19-
* **Unified Secrets Management:** Bridges the gap between personal password management and infrastructure-level key handling.
26+
- **Unified Secrets Management:** Bridges the gap between personal password
27+
management and infrastructure-level key handling.
2028

21-
* **Decentralized and Local-First:** Your secrets never leave your device unless you choose to share them.
29+
- **Decentralized and Local-First:** Your secrets never leave your device unless
30+
you choose to share them.
2231

23-
* **Seamless Synchronization:** Backup and sync secrets across desktops, mobile devices, and servers.
32+
- **Seamless Synchronization:** Backup and sync secrets across desktops, mobile
33+
devices, and servers.
2434

25-
* **Comprehensive Encryption:** All data is end-to-end encrypted in transit and encrypted at rest.
35+
- **Comprehensive Encryption:** All data is end-to-end encrypted in transit and
36+
encrypted at rest.
2637

27-
Polykey is an open-source, peer-to-peer secrets management system. Each Polykey agent runs locally as a node in the network, managing secrets and enabling sharing with trusted peers. Secrets are stored within encrypted vaults and can be placed anywhere on your system, including external storage like USB drives.
38+
Polykey is an open-source, peer-to-peer secrets management system. Each Polykey
39+
agent runs locally as a node in the network, managing secrets and enabling
40+
sharing with trusted peers. Secrets are stored within encrypted vaults and can
41+
be placed anywhere on your system, including external storage like USB drives.
2842

2943
## Features
3044

31-
Polykey delivers robust, decentralized secrets management through the following capabilities:
45+
Polykey delivers robust, decentralized secrets management through the following
46+
capabilities:
3247

33-
* **Decentralized & Local-First:** Operates entirely on your device in a peer-to-peer network, giving you full control over your secrets.
48+
- **Decentralized & Local-First:** Operates entirely on your device in a
49+
peer-to-peer network, giving you full control over your secrets.
3450

35-
* **State-of-the-Art Cryptography:** Employs XChaCha20-Poly1305 for encryption, X25519 for key exchange, and Ed25519 for signatures, ensuring confidentiality and integrity.
51+
- **State-of-the-Art Cryptography:** Employs XChaCha20-Poly1305 for encryption,
52+
X25519 for key exchange, and Ed25519 for signatures, ensuring confidentiality
53+
and integrity.
3654

37-
* **Secure Vault Architecture:** Secrets are organized into fully encrypted, version-controlled vaults that function like a secure, virtual filesystem, enabling safe storage, backup, and sharing with trusted peers. Data remains encrypted at rest, even when the Polykey agent is not running. It is only decrypted when the agent is launched and the user authenticates.
55+
- **Secure Vault Architecture:** Secrets are organized into fully encrypted,
56+
version-controlled vaults that function like a secure, virtual filesystem,
57+
enabling safe storage, backup, and sharing with trusted peers. Data remains
58+
encrypted at rest, even when the Polykey agent is not running. It is only
59+
decrypted when the agent is launched and the user authenticates.
3860

39-
* **Gestalt Identity Model:** Aggregates multiple digital identities into a unified, trusted representation to facilitate secure sharing.
61+
- **Gestalt Identity Model:** Aggregates multiple digital identities into a
62+
unified, trusted representation to facilitate secure sharing.
4063

41-
* **Integration & Automation:** Works interactively or via CLI integration for seamless inclusion in CI/CD pipelines and system workflows.
64+
- **Integration & Automation:** Works interactively or via CLI integration for
65+
seamless inclusion in CI/CD pipelines and system workflows.
4266

43-
* **Cross-Platform & Open Source:** Actively maintained, open-source, and operable across multiple environments.
67+
- **Cross-Platform & Open Source:** Actively maintained, open-source, and
68+
operable across multiple environments.
4469

45-
* **Forward-Looking Security:** Investigating post-quantum cryptography and advanced protective mechanisms to stay ahead of evolving threats.
70+
- **Forward-Looking Security:** Investigating post-quantum cryptography and
71+
advanced protective mechanisms to stay ahead of evolving threats.
4672

4773
## Core Concepts
4874

4975
### Secrets Management
5076

51-
Polykey was purpose-built for secrets management: any data that enables capability.
77+
Polykey was purpose-built for secrets management: any data that enables
78+
capability.
5279

53-
* **Passwords** for authentication
80+
- **Passwords** for authentication
5481

55-
* **Private Keys** for signing or decryption
82+
- **Private Keys** for signing or decryption
5683

57-
* **Tokens** for machine-to-service authentication
84+
- **Tokens** for machine-to-service authentication
5885

59-
* **Credit Card Info** for payments
86+
- **Credit Card Info** for payments
6087

61-
All secrets are stored in encrypted vaults with automatic versioning. Vaults can be shared securely with other Polykey agents. Secrets are treated as capabilities, or elements that grant power in both digital and physical systems.
88+
All secrets are stored in encrypted vaults with automatic versioning. Vaults can
89+
be shared securely with other Polykey agents. Secrets are treated as
90+
capabilities, or elements that grant power in both digital and physical systems.
6291

6392
### Decentralized Trust
6493

65-
Secret sharing relies on secure communications, which require trusted identities. Polykey introduces Gestalt Identity:
94+
Secret sharing relies on secure communications, which require trusted
95+
identities. Polykey introduces Gestalt Identity:
6696

67-
A **Gestalt Identity** is a collection of digital identities (e.g., social profiles, Polykey nodes) representing the same person or agent.
97+
A **Gestalt Identity** is a collection of digital identities (e.g., social
98+
profiles, Polykey nodes) representing the same person or agent.
6899

69-
* When a Polykey agent starts, it begins with a single-node gestalt.
100+
- When a Polykey agent starts, it begins with a single-node gestalt.
70101

71-
* Users can link other identities to expand trust.
102+
- Users can link other identities to expand trust.
72103

73-
* Gestalts allow others to verify and trust your identity when sharing secrets.
104+
- Gestalts allow others to verify and trust your identity when sharing secrets.
74105

75-
Trust in Polykey is compositional, built from the integrity of all linked identities in your gestalt.
106+
Trust in Polykey is compositional, built from the integrity of all linked
107+
identities in your gestalt.

0 commit comments

Comments
 (0)