std/README.md

50 lines
1.8 KiB
Markdown
Raw Normal View History

# Deno Standard Modules
2018-11-07 19:28:47 +00:00
2019-01-04 04:11:40 +00:00
[![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)
2018-11-07 19:28:47 +00:00
2019-01-15 17:28:09 +00:00
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.
2019-01-03 16:40:09 +00:00
2019-01-15 17:28:09 +00:00
Contributions are welcome!
2019-01-03 16:40:09 +00:00
2019-01-15 17:28:09 +00:00
## How to use
2019-01-03 16:40:09 +00:00
2019-01-15 17:28:09 +00:00
These modules are tagged in accordance with Deno releases. So, for example, the
2019-03-02 20:49:39 +00:00
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/`
2019-01-03 16:40:09 +00:00
2019-01-15 17:28:09 +00:00
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.
2018-12-24 15:28:01 +00:00
2019-04-13 19:30:56 +00:00
## Documentation
Here are the dedicated documentations of modules:
- [colors](colors/README.md)
- [datetime](datetime/README.md)
2019-05-30 13:50:29 +00:00
- [encoding](encoding/README.md)
2019-04-13 19:30:56 +00:00
- [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)
- [ws](ws/README.md)
2019-04-13 19:30:56 +00:00
2019-02-12 23:23:49 +00:00
## Contributing
2019-01-04 04:13:21 +00:00
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.
2019-02-12 23:23:49 +00:00
Follow the [style guide](https://deno.land/style_guide.html).