Skip to content

Commit 8df1c5b

Browse files
committed
stamp: adding useful links to main Readme
1 parent a49e922 commit 8df1c5b

File tree

4 files changed

+24
-4
lines changed

4 files changed

+24
-4
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ The edge runtime can be divided into two runtimes with different purposes.
3232
- Limits are required to be set such as: Memory and Timeouts.
3333
- Has access to environment variables explictly allowed by the main runtime.
3434

35+
### Edge Runtime in Deep
36+
37+
#### Conceptual
38+
39+
- [EdgeRuntime Base](/crates/base/README.md): Overalls about how EdgeRuntime is based on Deno.
40+
41+
#### Extension Modules
42+
43+
- [AI](/ext/ai/README.md): Implements AI related features.
44+
- [NodeJs](/ext/node/README.md) & [NodeJs Polyfills](/ext/node/polyfills/README.md): Implements the NodeJs compatibility layer.
45+
3546
## Developers
3647

3748
To learn how to build / test Edge Runtime, visit [DEVELOPERS.md](DEVELOPERS.md)

crates/base/README.md

Whitespace-only changes.

ext/node/README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1-
# deno_node
1+
# Supabase Node module
2+
3+
This crate is part of the Supabase Edge Runtime stack and implements NodeJs
4+
related features.
5+
6+
To see all compatible features, please check the
7+
[NodeJs Polyfills](/ext/node/polyfills/README.md) section.
8+
9+
## deno_node
210

311
`require` and other node related functionality for Deno.

ext/node/polyfills/README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Deno Node.js compatibility
1+
# Supabase Node.js compatibility module
22

3-
This module is meant to have a compatibility layer for the
3+
This crate is part of the Supabase Edge Runtime stack and implements a
4+
compatibility layer for the
45
[Node.js standard library](https://nodejs.org/docs/latest/api/).
56

67
**Warning**: Any function of this module should not be referred anywhere in the
@@ -59,7 +60,7 @@ Deno standard library as it's a compatibility module.
5960
- [x] worker_threads
6061
- [ ] zlib
6162

62-
* [x] node globals _partly_
63+
- [x] node globals _partly_
6364

6465
### Deprecated
6566

0 commit comments

Comments
 (0)