summaryrefslogtreecommitdiff
path: root/std/README.md
diff options
context:
space:
mode:
authorRyan Dahl <ry@tinyclouds.org>2019-10-09 17:10:09 -0400
committerRyan Dahl <ry@tinyclouds.org>2019-10-09 17:10:09 -0400
commit151ce0266eb4de2c8fc600c81c192a5f791b6169 (patch)
tree7cb04016a1c7ee88adde83814548d7a9409dcde3 /std/README.md
parenta355f7c807686918734416d91b79c26c21effba9 (diff)
Move everything into std subdir
Diffstat (limited to 'std/README.md')
-rw-r--r--std/README.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/std/README.md b/std/README.md
new file mode 100644
index 000000000..5e2cbf044
--- /dev/null
+++ b/std/README.md
@@ -0,0 +1,50 @@
+# Deno Standard Modules
+
+[![Build Status](https://dev.azure.com/denoland/deno_std/_apis/build/status/denoland.deno_std?branchName=master)](https://dev.azure.com/denoland/deno_std/_build/latest?definitionId=2?branchName=master)
+
+These modules do not have external dependencies and they are reviewed by the
+Deno core team. The intention is to have a standard set of high quality code
+that all Deno projects can use fearlessly.
+
+Contributions are welcome!
+
+## How to use
+
+These modules are tagged in accordance with Deno releases. So, for example, the
+v0.3.0 tag is guaranteed to work with deno v0.3.0.
+You can link to v0.3.0 using the URL `https://deno.land/std@v0.3.0/`
+
+It's strongly recommended that you link to tagged releases rather than the
+master branch. The project is still young and we expect disruptive renames in
+the future.
+
+## Documentation
+
+Here are the dedicated documentations of modules:
+
+- [colors](fmt/colors.ts)
+- [datetime](datetime/README.md)
+- [encoding](encoding/README.md)
+- [examples](examples/README.md)
+- [flags](flags/README.md)
+- [fs](fs/README.md)
+- [http](http/README.md)
+- [log](log/README.md)
+- [media_types](media_types/README.md)
+- [prettier](prettier/README.md)
+- [strings](strings/README.md)
+- [testing](testing/README.md)
+- [uuid](uuid/README.md)
+- [ws](ws/README.md)
+
+## Contributing
+
+deno_std is a loose port of [Go's standard library](https://golang.org/pkg/).
+When in doubt, simply port Go's source code, documentation, and tests. There
+are many times when the nature of JavaScript, TypeScript, or Deno itself
+justifies diverging from Go, but if possible we want to leverage the energy that
+went into building Go. We generally welcome direct ports of Go's code.
+
+Please ensure the copyright headers cite the code's origin.
+
+Follow the [style guide](https://deno.land/style_guide.html).