You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: refine README for better clarity and user navigation
Enhance the README documentation for the Polykey CLI tutorials page by restructuring the overview, clarifying the supported platforms, and providing a more organized guide through the tutorial sections. Include links to further resources for user engagement and outline advanced scenarios to prepare users for comprehensive usage of Polykey's features.
Copy file name to clipboardExpand all lines: docs/tutorials/polykey-cli/README.md
+20-20Lines changed: 20 additions & 20 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,12 +14,12 @@ The tutorial here should be followed in order, and the goal is to make use of Po
14
14
15
15
The CLI is open-source and available on GitHub: [Polykey CLI](https://github.com/MatrixAI/Polykey-CLI).
16
16
17
-
We automatically build and test the CLI on the following platforms:
17
+
### Supported Platforms
18
18
19
-
- Linux x64
20
-
- Linux arm64
21
-
-MacOS x64
22
-
- MacOS arm64
19
+
Polykey is continuously built and tested on:
20
+
21
+
-Linux x64 / arm64
22
+
- MacOS x64 / arm64
23
23
- Windows x64
24
24
- Docker
25
25
@@ -29,28 +29,28 @@ Polykey is currently in beta. Its interface is at various levels of stability. S
29
29
30
30
## Getting Started
31
31
32
-
To begin managing & sharing secrets effectively with Polykey, follow the tutorials in the sequence outlined below:
32
+
Start your journey with Polykey by following the tutorials below in sequence:
33
33
34
34
:::tip
35
-
You may also reference the following [demo video](https://vimeo.com/884649667)for the getting started tutorial but you will first need to complete the installation instructions for Polykey-CLI.
35
+
For a visual walkthrough, check out our [getting started demo video](https://vimeo.com/884649667)after installing Polykey.
36
36
:::
37
37
38
-
1.**[Installation](/docs/tutorials/polykey-cli/installation)**: Set up Polykey CLI on your preferred platform.
39
-
2.**[Bootstrap Keypair](/docs/tutorials/polykey-cli/bootstrapping)**: Initialize your node and connect to the Polykey network.
40
-
3.**[Managing Vaults](/docs/tutorials/polykey-cli/managing-vaults)**: Create and manage secure vaults for effective secrets storage.
41
-
4.**[Managing Secrets](/docs/tutorials/polykey-cli/managing-secrets)**: Explore comprehensive methods for handling and organizing secrets within vaults.
42
-
5.**[Claiming Digital Identities](/docs/tutorials/polykey-cli/claiming-digital-identities)**: Authenticate and establish your identity across the Polykey network.
43
-
6.**[Discovering Other User's Identities](/docs/tutorials/polykey-cli/discovering-other-users)**: Locate and verify identities of other users to manage access.
44
-
7.**[Sharing Vaults](/docs/tutorials/polykey-cli/sharing-vaults)**: Share vaults securely with trusted peers.
45
-
46
-
These initial tutorials will guide new users through the basic functionalities of setting up Polykey, starting their node (similar to creating a Web3 wallet connected to a P2P network), creating virtual encrypted vaults, and managing secret files within these vaults. This foundation prepares users for more advanced network functionalities, such as identity claims, discovery of other users' nodes, and secure sharing of secrets and vaults through end-to-end encryption.
38
+
1.**[Installation](/docs/tutorials/polykey-cli/installation)** - Install Polykey CLI on your platform.
39
+
2.**[Bootstrap Keypair](/docs/tutorials/polykey-cli/bootstrapping)** - Set up your node and connect to the network.
40
+
3.**[Managing Vaults](/docs/tutorials/polykey-cli/managing-vaults)** - Securely store secrets within encrypted vaults.
41
+
4.**[Managing Secrets](/docs/tutorials/polykey-cli/managing-secrets)** - Organize and handle secrets within your vaults.
42
+
5.**[Claiming Digital Identities](/docs/tutorials/polykey-cli/claiming-digital-identities)** - Establish and authenticate your identity within the network.
43
+
6.**[Discovering Other User's Identities](/docs/tutorials/polykey-cli/discovering-other-users)** - Find and verify other users to manage permissions.
44
+
7.**[Sharing Vaults](/docs/tutorials/polykey-cli/sharing-vaults)** - Share your encrypted vaults securely with peers.
45
+
8.**[Managing Multiple Nodes](/docs/tutorials/polykey-cli/managing-multiple-nodes)** - Operate multiple local nodes/agents.
After mastering these basics, you'll be ready to explore intermediate use-cases such as:
48
+
Explore advanced scenarios in subsequent sections, including:
49
49
50
50
- Managing multiple local nodes
51
-
-Linking multiple nodes to a single identity
52
-
-Using Polykey's `env` command to inject secrets into your development environment
51
+
-Integrating multiple nodes with a single identity
52
+
-Injecting secrets directly into your development environments using Polykey’s `env` command
53
53
54
-
These topics will be covered in more detail in the next section of our documentation, providing you with the tools to leverage Polykey's full potential in more complex operational environments.
54
+
This will prepare you to fully exploit Polykey’s capabilities in diverse and complex operational settings.
0 commit comments