update readmes (#3765)

This commit is contained in:
Ryan Dahl 2020-01-23 16:32:52 -05:00 committed by Bartek Iwańczuk
parent 5a658a2ff7
commit 74e6eb14dd
4 changed files with 25 additions and 8 deletions

8
cli/README.md Normal file
View file

@ -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.

View file

@ -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);

View file

@ -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

View file

@ -1,8 +1,7 @@
# Deno TypeScript Crate
[![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 provides utilities to compile typescript, bundle it up, and create a
V8 snapshot, all during build. This allows users to startup fast.
The cli_snapshots crate, neighboring this one uses deno_typescript at build
time.
This crate does not depend on Node, Python, nor any other external dependencies
besides those listed as such in Cargo.toml.
V8 snapshot, all during build. Snapshots allow the executable to startup fast.