Skip to content

Commit

Permalink
Remove wzrd.in from README (#323)
Browse files Browse the repository at this point in the history
* 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
browserify/wzrd.in@2f7ea69

It currently throws 502 errors on all packages as reported in
#302 or
https://talk.observablehq.com/t/wzrd-in-alternatives/571

As stated in
#293 (comment)
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 #317

However for the time being let's at least remove these broken
instructions from the README.

Closes #176, #302
  • Loading branch information
ctavan authored and broofa committed Sep 1, 2019
1 parent ab33c8a commit eea07e8
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 84 deletions.
84 changes: 40 additions & 44 deletions README.md
Expand Up @@ -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
<script src="http://wzrd.in/standalone/uuid%2Fv1@latest"></script>
<script>
uuidv1(); // -> v1 UUID
</script>
```

For version 3 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv3@latest"></script>
<script>
uuidv3('http://example.com/hello', uuidv3.URL); // -> v3 UUID
</script>
```

For version 4 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv4@latest"></script>
<script>
uuidv4(); // -> v4 UUID
</script>
```

For version 5 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv5@latest"></script>
<script>
uuidv5('http://example.com/hello', uuidv5.URL); // -> v5 UUID
</script>
```

## API

### Version 1
Expand Down Expand Up @@ -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
// ]

```

Expand Down Expand Up @@ -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
// ]

```

Expand Down
40 changes: 0 additions & 40 deletions README_js.md
Expand Up @@ -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
<script src="http://wzrd.in/standalone/uuid%2Fv1@latest"></script>
<script>
uuidv1(); // -> v1 UUID
</script>
```

For version 3 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv3@latest"></script>
<script>
uuidv3('http://example.com/hello', uuidv3.URL); // -> v3 UUID
</script>
```

For version 4 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv4@latest"></script>
<script>
uuidv4(); // -> v4 UUID
</script>
```

For version 5 uuids:

```html
<script src="http://wzrd.in/standalone/uuid%2Fv5@latest"></script>
<script>
uuidv5('http://example.com/hello', uuidv5.URL); // -> v5 UUID
</script>
```

## API

### Version 1
Expand Down

0 comments on commit eea07e8

Please sign in to comment.