mirror of
https://github.com/denoland/deno.git
synced 2024-11-21 20:38:55 +00:00
improve readme (#7530)
This commit is contained in:
parent
7713274efd
commit
04f05d0d9d
92
README.md
92
README.md
@ -1,29 +1,91 @@
|
||||
# Deno
|
||||
|
||||
A secure runtime for JavaScript and TypeScript.
|
||||
[![Build Status - Cirrus][]][Build status] [![Twitter handle][]][Twitter badge]
|
||||
|
||||
[![Build Status](https://github.com/denoland/deno/workflows/ci/badge.svg?branch=master&event=push)](https://github.com/denoland/deno/actions)
|
||||
<img align="right" src=https://deno.land/logo.svg height="150px">
|
||||
|
||||
Deno aims to provide a productive and secure scripting environment for the
|
||||
modern programmer. It is built on top of V8, Rust, and TypeScript.
|
||||
Deno is a _simple_, _modern_ and _secure_ runtime for **JavaScript** and
|
||||
**TypeScript** that uses V8 and is built in Rust.
|
||||
|
||||
Please read the [introduction](https://deno.land/manual#introduction) for more
|
||||
specifics.
|
||||
### Features
|
||||
|
||||
[Website](https://deno.land/)
|
||||
- Secure by default. No file, network, or environment access, unless explicitly
|
||||
enabled.
|
||||
- Supports TypeScript out of the box.
|
||||
- Ships only a single executable file.
|
||||
- Built-in utilities like a dependency inspector (deno info) and a code
|
||||
formatter (deno fmt).
|
||||
- Set of reviewed standard modules that are guaranteed to work with
|
||||
[Deno](https://deno.land/std/)
|
||||
|
||||
[Manual](https://deno.land/manual)
|
||||
### Install
|
||||
|
||||
[Install](https://github.com/denoland/deno_install)
|
||||
Shell (Mac, Linux):
|
||||
|
||||
[API Reference](https://doc.deno.land)
|
||||
```sh
|
||||
curl -fsSL https://deno.land/x/install/install.sh | sh
|
||||
```
|
||||
|
||||
[Style Guide](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)
|
||||
PowerShell (Windows):
|
||||
|
||||
[Module Repository](https://deno.land/x/)
|
||||
```powershell
|
||||
iwr https://deno.land/x/install/install.ps1 -useb | iex
|
||||
```
|
||||
|
||||
[Releases](Releases.md)
|
||||
[Homebrew](https://formulae.brew.sh/formula/deno) (Mac):
|
||||
|
||||
[Chat](https://discord.gg/deno)
|
||||
```sh
|
||||
brew install deno
|
||||
```
|
||||
|
||||
[More links](https://github.com/denolib/awesome-deno)
|
||||
[Chocolatey](https://chocolatey.org/packages/deno) (Windows):
|
||||
|
||||
```powershell
|
||||
choco install deno
|
||||
```
|
||||
|
||||
Build and install from source using [Cargo](https://crates.io/crates/deno):
|
||||
|
||||
```sh
|
||||
cargo install deno
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```sh
|
||||
deno run https://deno.land/std/examples/welcome.ts
|
||||
```
|
||||
|
||||
Or a more complex one:
|
||||
|
||||
```sh
|
||||
import { serve } from "https://deno.land/std@0.69.0/http/server.ts";
|
||||
const s = serve({ port: 8000 });
|
||||
console.log("http://localhost:8000/");
|
||||
for await (const req of s) {
|
||||
req.respond({ body: "Hello World\n" });
|
||||
}
|
||||
```
|
||||
|
||||
You can find a more in depth introduction, examples, and environment setup
|
||||
guides in the [manual](https://deno.land/manual).
|
||||
|
||||
More in-depth info can be found in the runtime [documentation](doc.deno.land)
|
||||
|
||||
### Contributing
|
||||
|
||||
We appreciate your help!
|
||||
|
||||
To contribute, please read the our
|
||||
[guidelines](https://github.com/denoland/deno/blob/master/docs/contributing/style_guide.md)
|
||||
|
||||
[Build Status - Cirrus]: https://github.com/denoland/deno/workflows/ci/badge.svg?branch=master&event=push
|
||||
[Build status]: https://github.com/denoland/deno/actions
|
||||
[Twitter badge]: https://twitter.com/intent/follow?screen_name=deno_land
|
||||
[Twitter handle]: https://img.shields.io/twitter/follow/deno_land.svg?style=social&label=Follow
|
||||
|
Loading…
Reference in New Issue
Block a user