summaryrefslogtreecommitdiff
path: root/js/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'js/README.md')
-rw-r--r--js/README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/js/README.md b/js/README.md
new file mode 100644
index 000000000..850adb6ee
--- /dev/null
+++ b/js/README.md
@@ -0,0 +1,10 @@
+# Crate: `deno_cli_snapshots`
+
+## AKA `cli_snapshots` AKA `//js`
+
+This is a small crate which exports just a few static blobs. It contains a
+build.rs file which compiles Deno's internal JavaScript and TypeScript code
+first into a single AMD bundle, and then into a binary V8 Snapshot.
+
+The main Deno executable crate ("cli") depends on this crate and has access to
+all the runtime code.