From 2929c06ae82dbce60bdfa7edd019f6a34fc401c3 Mon Sep 17 00:00:00 2001 From: Glenn Rempe <117+grempe@users.noreply.github.com> Date: Fri, 11 Feb 2022 17:24:18 -0500 Subject: [PATCH] docs: Include link to ULID generator demo API in README #3 (#9) --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/README.md b/README.md index 6e297cf..b19bedf 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,39 @@ Then you might want to use the `non-monotonic` configuration, sacrificing sortab We think for most use-cases for use within Cloudflare Workers these concerns are of lesser importance so we've chosen to use `monotonic` by default. +## Demonstration API + +If you'd like to generate `ULID`s there is a public API at [ulid.truestamp.com](https://ulid.truestamp.com/) that is implemented using a Cloudflare Worker and a global singleton Durable Object that creates all ULIDs using this library. + +Learn more: + + + +Example: + +[https://ulid.truestamp.com/?q=3](https://ulid.truestamp.com/?q=3) + +```sh +❯ https --print b https://ulid.truestamp.com q==3 +[ + { + "t": 1644553645224, + "ts": "2022-02-11T04:27:25.224Z", + "ulid": "01FVKGJB58M3ERB35J6KFKPPK8" + }, + { + "t": 1644553645224, + "ts": "2022-02-11T04:27:25.224Z", + "ulid": "01FVKGJB58M3ERB35J6KFKPPK9" + }, + { + "t": 1644553645224, + "ts": "2022-02-11T04:27:25.224Z", + "ulid": "01FVKGJB58M3ERB35J6KFKPPKA" + } +] +``` + ## Installation Install using npm by running: