summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRyan Dahl <ry@tinyclouds.org>2020-01-23 16:32:52 -0500
committerBartek IwaƄczuk <biwanczuk@gmail.com>2020-01-23 22:32:52 +0100
commit74e6eb14dd4697ba8bf52e044af0e7dfef49e441 (patch)
tree8d2729ad1b89f8e1de52c81de1b00c4a1328fd7e
parent5a658a2ff758faef4a3d864ba0b2324fa731dfcc (diff)
update readmes (#3765)
-rw-r--r--cli/README.md8
-rw-r--r--cli/js/net_test.ts3
-rw-r--r--core/README.md9
-rw-r--r--deno_typescript/README.md11
4 files changed, 24 insertions, 7 deletions
diff --git a/cli/README.md b/cli/README.md
new file mode 100644
index 000000000..778b279ec
--- /dev/null
+++ b/cli/README.md
@@ -0,0 +1,8 @@
+# Deno CLI Crate
+
+[![crates](https://img.shields.io/crates/v/deno.svg)](https://crates.io/crates/deno)
+[![docs](https://docs.rs/deno/badge.svg)](https://docs.rs/deno)
+
+This provides the actual deno executable and the user-facing APIs.
+
+The deno crate uses the deno_core and deno_typescript to provide the executable.
diff --git a/cli/js/net_test.ts b/cli/js/net_test.ts
index e4d0be81f..7f5334df3 100644
--- a/cli/js/net_test.ts
+++ b/cli/js/net_test.ts
@@ -1,5 +1,6 @@
// Copyright 2018-2020 the Deno authors. All rights reserved. MIT license.
import { testPerm, assert, assertEquals } from "./test_util.ts";
+import { runIfMain } from "../../std/testing/mod.ts";
testPerm({ net: true }, function netListenClose(): void {
const listener = Deno.listen({ hostname: "127.0.0.1", port: 4500 });
@@ -239,3 +240,5 @@ testPerm({ net: true }, async function netDoubleCloseWrite() {
conn.close();
});
*/
+
+runIfMain(import.meta);
diff --git a/core/README.md b/core/README.md
index 9345b6eff..579fe6093 100644
--- a/core/README.md
+++ b/core/README.md
@@ -1,4 +1,11 @@
-# Deno Core
+# Deno Core Crate
+
+[![crates](https://img.shields.io/crates/v/deno_core.svg)](https://crates.io/crates/deno_core)
+[![docs](https://docs.rs/deno_core/badge.svg)](https://docs.rs/deno_core)
+
+The main dependency of this crate is
+[rusty_v8](https://github.com/denoland/rusty_v8), which provides the V8-Rust
+bindings.
This Rust crate contains the essential V8 bindings for Deno's command-line
interface (Deno CLI). The main abstraction here is the Isolate which provides a
diff --git a/deno_typescript/README.md b/deno_typescript/README.md
index d51e88e72..c2fb7f5a5 100644
--- a/deno_typescript/README.md
+++ b/deno_typescript/README.md
@@ -1,8 +1,7 @@
-This crate provides utilities to compile typescript, bundle it up, and create a
-V8 snapshot, all during build. This allows users to startup fast.
+# Deno TypeScript Crate
-The cli_snapshots crate, neighboring this one uses deno_typescript at build
-time.
+[![crates](https://img.shields.io/crates/v/deno_typescript.svg)](https://crates.io/crates/deno_typescript)
+[![docs](https://docs.rs/deno_typescript/badge.svg)](https://docs.rs/deno_typescript)
-This crate does not depend on Node, Python, nor any other external dependencies
-besides those listed as such in Cargo.toml.
+This crate provides utilities to compile typescript, bundle it up, and create a
+V8 snapshot, all during build. Snapshots allow the executable to startup fast.