Skip to content

Commit 5e786c6

Browse files
committed
chore: update js-lint to 0.2.11 and delete .prettierrc since its no longer needed
also removed lintshell script from package.json since it was already included in js-lint
1 parent ea69b5f commit 5e786c6

File tree

4 files changed

+43
-29
lines changed

4 files changed

+43
-29
lines changed

.prettierrc

Lines changed: 0 additions & 7 deletions
This file was deleted.

README.md

Lines changed: 38 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,41 @@
1616

1717
## What is Polykey?
1818

19-
**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.
20-
21-
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.**
22-
23-
- **All data is end-to-end encrypted**, both in transit and at rest, eliminating the risk associated with third-party storage.
24-
- **Polykey provides a command line interface**, desktop and mobile GUI, and a web-based control plane for organizational management.
25-
- 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.
26-
- Unlike complex self-hosted secrets management systems that require specialized skills and infrastructure, Polykey is **installed and running directly from the end-user device**.
27-
- It is built to **automatically navigate network complexities** like NAT traversal, connecting securely to other nodes without manual configuration.
19+
**Polykey is an open-source, peer-to-peer system** that addresses the critical
20+
challenge in cybersecurity: **the secure sharing and delegation of authority**,
21+
in the form of secrets like keys, tokens, certificates, and passwords.
22+
23+
It allows users including developers, organizations, and machines—to **store
24+
these secrets in encrypted vaults on their own devices, and share them directly
25+
with trusted parties.**
26+
27+
- **All data is end-to-end encrypted**, both in transit and at rest, eliminating
28+
the risk associated with third-party storage.
29+
- **Polykey provides a command line interface**, desktop and mobile GUI, and a
30+
web-based control plane for organizational management.
31+
- By treating secrets as tokenized authority, it offers a fresh approach to
32+
**managing and delegating authority in zero-trust architectures** without
33+
adding burdensome policy complexity - a pervasive issue in existing zero-trust
34+
systems.
35+
- Unlike complex self-hosted secrets management systems that require specialized
36+
skills and infrastructure, Polykey is **installed and running directly from
37+
the end-user device**.
38+
- It is built to **automatically navigate network complexities** like NAT
39+
traversal, connecting securely to other nodes without manual configuration.
2840

2941
**Key features:**
3042

31-
- **Decentralized Encrypted Storage** - No storage of secrets on third parties, secrets are stored on your device and synchronised point-to-point between Polykey nodes.
32-
- **Secure Peer-to-Peer Communication** - Polykey bootstraps TLS keys by federating trusted social identities (e.g. GitHub).
33-
- **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.
34-
- With Polykey Enterprise, you can create private networks of Polykey nodes and apply mandatory policy governing node behaviour.
43+
- **Decentralized Encrypted Storage** - No storage of secrets on third parties,
44+
secrets are stored on your device and synchronised point-to-point between
45+
Polykey nodes.
46+
- **Secure Peer-to-Peer Communication** - Polykey bootstraps TLS keys by
47+
federating trusted social identities (e.g. GitHub).
48+
- **Secure Computational Workflows** - Share static secrets (passwords, keys,
49+
tokens and certificates) with people, between teams, and across machine
50+
infrastructure. Create dynamic (short-lived) smart-tokens with embedded policy
51+
for more sophisticated zero-trust authority verification.
52+
- With Polykey Enterprise, you can create private networks of Polykey nodes and
53+
apply mandatory policy governing node behaviour.
3554

3655
## Table of Contents
3756

@@ -46,7 +65,8 @@ It allows users including developers, organizations, and machines—to **store t
4665

4766
## Installation
4867

49-
Note that JavaScript libraries are not packaged in Nix. Only JavaScript applications are.
68+
Note that JavaScript libraries are not packaged in Nix. Only JavaScript
69+
applications are.
5070

5171
Building the package:
5272

@@ -114,7 +134,8 @@ When calling commands in development, use this style:
114134
npm run polykey -- p1 p2 p3
115135
```
116136

117-
The `--` is necessary to make `npm` understand that the parameters are for your own executable, and not parameters to `npm`.
137+
The `--` is necessary to make `npm` understand that the parameters are for your
138+
own executable, and not parameters to `npm`.
118139

119140
### Docs Generation
120141

@@ -137,4 +158,5 @@ git push --tags
137158

138159
## License
139160

140-
Polykey-CLI is licensed under the GPLv3, you may read the terms of the license [here](LICENSE).
161+
Polykey-CLI is licensed under the GPLv3, you may read the terms of the license
162+
[here](LICENSE).

package-lock.json

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,6 @@
118118
"test": "node ./scripts/test.mjs",
119119
"lint": "matrixai-lint",
120120
"lintfix": "matrixai-lint --fix",
121-
"lint-shell": "find ./src ./tests ./scripts -type f -regextype posix-extended -regex '.*\\.(sh)' -exec shellcheck {} +",
122121
"docs": "shx rm -rf ./docs && typedoc --gitRevision master --tsconfig ./tsconfig.build.json --out ./docs src",
123122
"pkg": "node ./scripts/build.mjs --pkg && node ./scripts/pkg.mjs",
124123
"polykey": "node ./scripts/build.mjs && node dist/polykey.mjs",
@@ -136,7 +135,7 @@
136135
"sodium-native": "*"
137136
},
138137
"devDependencies": {
139-
"@matrixai/lint" : "^0.2.6",
138+
"@matrixai/lint" : "^0.2.11",
140139
"@matrixai/errors": "^2.1.3",
141140
"@matrixai/logger": "^4.0.3",
142141
"@matrixai/exec": "^1.0.3",

0 commit comments

Comments
 (0)