Skip to content

Commit 786684e

Browse files
committed
chore: add README to all npm packages and update website URLs to secureexec.dev
1 parent 05dac2c commit 786684e

21 files changed

Lines changed: 107 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,21 @@
11
## Brand
22

33
- accent color: #CC0000 (red), light variant: #FF3333
4+
- website: https://secureexec.dev
5+
- docs: https://secureexec.dev/docs
6+
- GitHub: https://github.com/rivet-dev/secure-exec
7+
8+
## NPM Packages
9+
10+
- every publishable package must include a `README.md` with the standard format: title, tagline, and links to website, docs, and GitHub
11+
- if `package.json` has a `"files"` array, `"README.md"` must be listed in it
412

513
## Tooling
614

715
- use pnpm, vitest, and tsc for type checks
816
- use turbo for builds
917
- keep timeouts under 1 minute and avoid running full test suites unless necessary
1018
- use one-line Conventional Commit messages; never add any co-authors (including agents)
11-
- use one-line Conventional Commit messages; never add any co-authors (including agents)
1219
- never mark work complete until typechecks pass and all tests pass in the current turn; if they fail, report the failing command and first concrete error
1320
- always add or update tests that cover plausible exploit/abuse paths introduced by each feature or behavior change
1421
- treat host memory buildup and CPU amplification as critical risks; avoid unbounded buffering/work (for example, default in-memory log buffering)

packages/kernel/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/os/browser/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/os/node/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/runtime/node/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/runtime/python/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/runtime/wasmvm/README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

packages/secure-exec-browser/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@
66
"main": "./dist/index.js",
77
"types": "./dist/index.d.ts",
88
"files": [
9-
"dist"
9+
"dist",
10+
"README.md"
1011
],
1112
"exports": {
1213
".": {
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Secure Exec
2+
3+
Secure Node.js execution without a sandbox. V8 isolate-based code execution with full Node.js and npm compatibility.
4+
5+
- [Website](https://secureexec.dev)
6+
- [Documentation](https://secureexec.dev/docs)
7+
- [GitHub](https://github.com/rivet-dev/secure-exec)

0 commit comments

Comments
 (0)