From eea07e8484f72e52ba935c1b9cb491a2365ad858 Mon Sep 17 00:00:00 2001 From: Christoph Tavan Date: Sun, 1 Sep 2019 15:39:22 +0200 Subject: [PATCH] Remove wzrd.in from README (#323) * chore(doc): re-generate README * fix(doc): remove wzrd.in instruction from README The service wzrd.in seems to be unmaintained for over a year now, see https://github.com/browserify/wzrd.in/commit/2f7ea6969e290f62fbcd93d738cb66f6d902e1cf It currently throws 502 errors on all packages as reported in kelektiv/node-uuid#302 or https://talk.observablehq.com/t/wzrd-in-alternatives/571 As stated in https://github.com/kelektiv/node-uuid/pull/293#issuecomment-500009331 there are no plans to support legacy bundlers. Instead, we may consider to go for properly standardized ES6 modules in the future as has been teased in kelektiv/node-uuid#317 However for the time being let's at least remove these broken instructions from the README. Closes #176, #302 --- README.md | 84 +++++++++++++++++++++++++--------------------------- README_js.md | 40 ------------------------- 2 files changed, 40 insertions(+), 84 deletions(-) diff --git a/README.md b/README.md index 6fc3708b..34dd3d03 100644 --- a/README.md +++ b/README.md @@ -80,46 +80,6 @@ uuidv5('Hello, World!', MY_NAMESPACE); // ⇨ '630eb68f-e0fa-5ecc-887a-7c7a62614 ``` -## Quickstart - Browser-ready Versions - -Browser-ready versions of this module are available via [wzrd.in](https://github.com/jfhbrook/wzrd.in). - -For version 1 uuids: - -```html - - -``` - -For version 3 uuids: - -```html - - -``` - -For version 4 uuids: - -```html - - -``` - -For version 5 uuids: - -```html - - -``` - ## API ### Version 1 @@ -167,8 +127,26 @@ Example: In-place generation of two binary IDs ```javascript // Generate two ids in an array const arr = new Array(); -uuidv1(null, arr, 0); // ⇨ [ 44, 94, 164, 192, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125 ] -uuidv1(null, arr, 16); // ⇨ [ 44, 94, 164, 192, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125, 44, 94, 164, 193, 64, 103, 17, 233, 146, 52, 155, 29, 235, 77, 59, 125 ] +uuidv1(null, arr, 0); // ⇨ + // [ + // 44, 94, 164, + // 192, 64, 103, + // 17, 233, 146, + // 52, 155, 29, + // 235, 77, 59, + // 125 + // ] +uuidv1(null, arr, 16); // ⇨ + // [ + // 44, 94, 164, 192, + // 64, 103, 17, 233, + // 146, 52, 155, 29, + // 235, 77, 59, 125, + // 44, 94, 164, 193, + // 64, 103, 17, 233, + // 146, 52, 155, 29, + // 235, 77, 59, 125 + // ] ``` @@ -237,8 +215,26 @@ Example: Generate two IDs in a single buffer ```javascript const buffer = new Array(); -uuidv4(null, buffer, 0); // ⇨ [ 155, 29, 235, 77, 59, 125, 75, 173, 155, 221, 43, 13, 123, 61, 203, 109 ] -uuidv4(null, buffer, 16); // ⇨ [ 155, 29, 235, 77, 59, 125, 75, 173, 155, 221, 43, 13, 123, 61, 203, 109, 27, 157, 107, 205, 187, 253, 75, 45, 155, 93, 171, 141, 251, 189, 75, 237 ] +uuidv4(null, buffer, 0); // ⇨ + // [ + // 155, 29, 235, + // 77, 59, 125, + // 75, 173, 155, + // 221, 43, 13, + // 123, 61, 203, + // 109 + // ] +uuidv4(null, buffer, 16); // ⇨ + // [ + // 155, 29, 235, 77, + // 59, 125, 75, 173, + // 155, 221, 43, 13, + // 123, 61, 203, 109, + // 27, 157, 107, 205, + // 187, 253, 75, 45, + // 155, 93, 171, 141, + // 251, 189, 75, 237 + // ] ``` diff --git a/README_js.md b/README_js.md index 6c2547e1..709ceb20 100644 --- a/README_js.md +++ b/README_js.md @@ -89,46 +89,6 @@ const MY_NAMESPACE = '1b671a64-40d5-491e-99b0-da01ff1f3341'; uuidv5('Hello, World!', MY_NAMESPACE); // RESULT ``` -## Quickstart - Browser-ready Versions - -Browser-ready versions of this module are available via [wzrd.in](https://github.com/jfhbrook/wzrd.in). - -For version 1 uuids: - -```html - - -``` - -For version 3 uuids: - -```html - - -``` - -For version 4 uuids: - -```html - - -``` - -For version 5 uuids: - -```html - - -``` - ## API ### Version 1