Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Adds alternatives and updates description #28

Draft
wants to merge 3 commits into
base: master
Choose a base branch
from
Draft
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
[DOC] Updates project description
This adds a more detailed description including more information about
the user experience goals.

Relates #27
johnnyt committed Jul 11, 2020
commit beb2cb4fcbdec5deee91e9cf217b10cb76b1c761
31 changes: 27 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -10,22 +10,45 @@
*** for the actual URLs.
*** See: https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Issues][issues_shield]][issues_url]
[![MIT License][license_shield]][license_url]
# UXID [![Issues][issues_shield]][issues_url] [![MIT License][license_shield]][license_url]

This project contains the specification and reference implementations of a type of unique identifier called a UXID.

UXID stands for **U**ser e**X**perience focused **ID**entifier and is similar to a [ULID][ulid_url], with a strong focus on UX.

## Why UXIDs?

ID generation is a fun topic (for some :) and there are many existing libraries to do so (see [Alternatives]).
UXIDs build on strong concepts from some of these alternatives and have these primary goals:

* User experience focused
* No coordination, no collisions, no (fixed) cardinality
* Sortable by time

### User Experience Focused

Most ID generation libraries focus on creating unique identifiers to work for the system (often distributed) and give little thought to the humans who use them.

Who are these humans you speak of? There are two large groups:

* The customer and tech support heros who need to easily pronounce and hear them over the phone.
* The engineers investigating a complex issue with multiple objects of different types.


<!-- PROJECT LOGO -->
<!--
<br />
<p align="center">
<h1 align="center">UXID</h1>

<p align="center">
User Experience focused Identifiers
<b>U</b>ser e<b>X</b>perience focused <b>ID</b>entifiers
<br />
<br />
<a href="https://github.com/riddler/uxid/issues">Report Bug / Request Feature</a>
</p>
</p>

-->


<!-- TABLE OF CONTENTS -->