diff options
| author | Nayeem Rahman <nayeemrmn99@gmail.com> | 2020-05-09 13:34:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-09 08:34:47 -0400 |
| commit | f184332c09c851faac50f598d29ebe4426e05464 (patch) | |
| tree | 2659aba63702537fcde1bb64ddeafea1e5863f3e /std/README.md | |
| parent | 2b02535028f868ea8dfc471c4921a237747ccd4a (diff) | |
BREAKING(std): reorganization (#5087)
* Prepend underscores to private modules
* Remove collectUint8Arrays() It would be a misuse of Deno.iter()'s result.
* Move std/_util/async.ts to std/async
* Move std/util/sha*.ts to std/hash
Diffstat (limited to 'std/README.md')
| -rw-r--r-- | std/README.md | 35 |
1 files changed, 17 insertions, 18 deletions
diff --git a/std/README.md b/std/README.md index 76c4b4545..641146902 100644 --- a/std/README.md +++ b/std/README.md @@ -10,28 +10,27 @@ Contributions are welcome! 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/` +the URL `https://deno.land/std@v0.3.0/`. Not specifying a tag will link to the +master branch. -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. +It is strongly recommended that you link to tagged releases to avoid unintended +updates. + +Don't link to / import any module whose path: + +- Has a name or parent with an underscore prefix: `_foo.ts`, `_util/bar.ts`. +- Is that of a test module or test data: `test.ts`, `foo_test.ts`, + `testdata/bar.txt`. + +No stability is guaranteed for these files. ## 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) -- [node](node/README.md) -- [testing](testing/README.md) -- [uuid](uuid/README.md) -- [ws](ws/README.md) +To browse documentation for modules: + +- Go to https://deno.land/std/. +- Navigate to any module of interest. +- Click the "DOCUMENTATION" link. ## Contributing |