summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKevin Whinnery <kevin.whinnery@gmail.com>2023-11-27 13:18:14 -0600
committerGitHub <noreply@github.com>2023-11-27 13:18:14 -0600
commit90141d06ef7f751dfc6ef3b27a3a72c1417a242e (patch)
tree96dabf039729b9014799564c3d8849b0cf3c25c8 /README.md
parentf6cc80cddc73e833e9adcf89b4da56493e36ec37 (diff)
docs(README): Update README to include more recent links and use external docs (#21341)
Update the README to use current links, and link to appropriate external documentation for most information.
Diffstat (limited to 'README.md')
-rw-r--r--README.md106
1 files changed, 43 insertions, 63 deletions
diff --git a/README.md b/README.md
index 356e3c79f..08aa08fe9 100644
--- a/README.md
+++ b/README.md
@@ -6,26 +6,21 @@
<img align="right" src="https://deno.land/logo.svg" height="150px" alt="the deno mascot dinosaur standing in the rain">
-[Deno](https://deno.com/runtime) is a _simple_, _modern_ and _secure_ runtime
-for **JavaScript** and **TypeScript** that uses V8 and is built in Rust.
-
-### Features
-
-- [Secure by default.](https://deno.land/manual/basics/permissions) No file,
- network, or environment access, unless explicitly enabled.
-- Provides
- [web platform functionality and APIs](https://deno.land/manual/runtime/web_platform_apis),
- e.g. using ES modules, web workers, and `fetch()`.
-- Supports
- [TypeScript out of the box](https://deno.land/manual/advanced/typescript).
-- Ships only a single executable file.
-- [Built-in tooling](https://deno.land/manual/tools#built-in-tooling) including
- `deno test`, `deno fmt`, `deno bench`, and more.
-- Includes [a set of reviewed standard modules](https://deno.land/std/)
- guaranteed to work with Deno.
-- [Supports npm.](https://deno.land/manual/node)
-
-### Install
+[Deno](https://www.deno.com)
+([/ˈdiːnoʊ/](http://ipa-reader.xyz/?text=%CB%88di%CB%90no%CA%8A), pronounced
+`dee-no`) is a JavaScript, TypeScript, and WebAssembly runtime with secure
+defaults and a great developer experience. It's built on [V8](https://v8.dev/),
+[Rust](https://www.rust-lang.org/), and [Tokio](https://tokio.rs/).
+
+Learn more about the Deno runtime
+[in the documentation](https://docs.deno.com/runtime/manual).
+
+## Installation
+
+Install the Deno runtime on your system using one of the commands below. Note
+that there are a number of ways to install Deno - a comprehensive list of
+installation options can be found
+[here](https://docs.deno.com/runtime/manual/getting_started/installation).
Shell (Mac, Linux):
@@ -51,64 +46,49 @@ brew install deno
choco install deno
```
-[Scoop](https://scoop.sh/) (Windows):
+### Build and install from source
-```powershell
-scoop install deno
-```
+Complete instructions for building Deno from source can be found in the manual
+[here](https://docs.deno.com/runtime/manual/references/contributing/building_from_source).
-Build and install from source using [Cargo](https://crates.io/crates/deno):
+## Your first Deno program
-```sh
-# Install build dependencies
-apt install -y cmake protobuf-compiler # Linux
-brew install cmake protobuf # macOS
+Deno can be used for many different applications, but is most commonly used to
+build web servers. Create a file called `server.ts` and include the following
+TypeScript code:
-# Build and install Deno
-cargo install deno --locked
+```ts
+Deno.serve((_req: Request) => {
+ return new Response("Hello, world!");
+});
```
-See
-[deno_install](https://github.com/denoland/deno_install/blob/master/README.md)
-and [releases](https://github.com/denoland/deno/releases) for other options.
-
-### Getting Started
-
-Try [running a simple program](https://examples.deno.land/hello-world):
+Run your server with the following command:
```sh
-deno run https://examples.deno.land/hello-world.ts
-```
-
-Or [setup a simple HTTP server](https://examples.deno.land/http-server):
-
-```ts
-Deno.serve((_req) => new Response("Hello, World!"));
+deno run --allow-net server.ts
```
-[More Examples](https://examples.deno.land)
+This should start a local web server on
+[http://localhost:8000](http://localhost:8000).
-### Additional Resources
+Learm more about writing and running Deno programs
+[in the docs](https://docs.deno.com/runtime/manual).
-- **[The Deno Manual](https://deno.land/manual)** is a great starting point for
- [additional examples](https://deno.land/manual/examples),
- [setting up your environment](https://deno.land/manual/getting_started/setup_your_environment),
- [using npm](https://deno.land/manual/node), and more.
-- **[Runtime API reference](https://deno.land/api)** documents all APIs built
- into Deno CLI.
-- **[Deno Standard Modules](https://deno.land/std)** do not have external
- dependencies and are reviewed by the Deno core team.
-- **[deno.land/x](https://deno.land/x)** is the registry for third party
- modules.
-- **[Blog](https://deno.com/blog)** is where the Deno team shares important
- product updates and “how to”s about solving technical problems.
+## Additional resources
-### Contributing
+- **[Deno Docs](https://docs.deno.com)**: official guides and reference docs for
+ the Deno runtime, [Deno Deploy](https://deno.com/deploy), and beyond.
+- **[Deno Standard Library](https://deno.land/std)**: officially supported
+ common utilities for Deno programs.
+- **[deno.land/x](https://deno.land/x)**: registry for third-party Deno modules.
+- **[Developer Blog](https://deno.com/blog)**: Product updates, tutorials, and
+ more from the Deno team.
-We appreciate your help!
+## Contributing
-To contribute, please read our
-[contributing instructions](https://deno.land/manual/references/contributing/).
+We appreciate your help! To contribute, please read our
+[contributing instructions](https://docs.deno.com/runtime/manual/references/contributing/).
[Build status - Cirrus]: https://github.com/denoland/deno/workflows/ci/badge.svg?branch=main&event=push
[Build status]: https://github.com/denoland/deno/actions