Update to reflect repository changes

ulid · Dec 4, 2017 · 9dfe1d3 · 9dfe1d3
1 parent ef6e7bc
commit 9dfe1d3
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 152 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 	<br>
 </h1>
 
-[![Build Status](https://travis-ci.org/alizain/ulid.svg?branch=master)](https://travis-ci.org/alizain/ulid) [![codecov](https://codecov.io/gh/alizain/ulid/branch/master/graph/badge.svg)](https://codecov.io/gh/alizain/ulid)
+[![Build Status](https://travis-ci.org/ulid/javascript.svg?branch=master)](https://travis-ci.org/ulid/javascript) [![codecov](https://codecov.io/gh/ulid/javascript/branch/master/graph/badge.svg)](https://codecov.io/gh/ulid/javascript)
 [![npm](https://img.shields.io/npm/dm/localeval.svg)](https://www.npmjs.com/package/ulid)
 
 # Universally Unique Lexicographically Sortable Identifier
@@ -150,157 +150,11 @@ ulid() // 01BXAVRG61YJ5YSBRM51702F6M
 
 ## Implementations in other languages
 
-From the community!
-
-| Language | Author | Binary Implementation |
-| -------- | ------ | --------------------- |
-| [C++](https://github.com/suyash/ulid) | [suyash](https://github.com/suyash) | ✓ |
-| [Clojure](https://github.com/theikkila/clj-ulid) | [theikkila](https://github.com/theikkila) |
-| [Objective-C](https://github.com/whitesmith/ulid) | [ricardopereira](https://github.com/ricardopereira) |
-| [Crystal](https://github.com/SuperPaintman/ulid) | [SuperPaintman](https://github.com/SuperPaintman) |
-| [Dart](https://github.com/agilord/ulid) | [isoos](https://github.com/isoos) | ✓ |
-| [Delphi](https://github.com/martinusso/ulid) | [matinusso](https://github.com/martinusso) |
-| [D](https://github.com/enckse/ulid) | [enckse](https://github.com/enckse) |
-| [D (dub)](https://code.dlang.org/packages/ulid-d) | [extrawurst](https://github.com/Extrawurst)
-| [Erlang](https://github.com/savonarola/ulid) | [savonarola](https://github.com/savonarola) |
-| [Elixir](https://github.com/merongivian/ulid) | [merongivian](https://github.com/merongivian) |
-| [F#](https://github.com/lucasschejtman/FSharp.Ulid) | [lucasschejtman](https://github.com/lucasschejtman) |
-| [Go](https://github.com/imdario/go-ulid) | [imdario](https://github.com/imdario/) |
-| [Go](https://github.com/oklog/ulid) | [oklog](https://github.com/oklog) | ✓ |
-| [Haskell](https://github.com/steven777400/ulid) | [steven777400](https://github.com/steven777400) | ✓ |
-| [Java](https://github.com/huxi/sulky/tree/master/sulky-ulid) | [huxi](https://github.com/huxi) | ✓ |
-| [Java](https://github.com/azam/ulidj) | [azam](https://github.com/azam) |
-| [Java](https://github.com/Lewiscowles1986/jULID) | [Lewiscowles1986](https://github.com/Lewiscowles1986) |
-| [Julia](https://github.com/ararslan/ULID.jl) | [ararslan](https://github.com/ararslan) |
-| [Lua](https://github.com/Tieske/ulid.lua) | [Tieske](https://github.com/Tieske) |
-| [.NET](https://github.com/RobThree/NUlid) | [RobThree](https://github.com/RobThree) | ✓ |
-| [.NET](https://github.com/fvilers/ulid.net) | [fvilers](https://github.com/fvilers)
-| [Nim](https://github.com/adelq/ulid) | [adelq](https://github.com/adelq)
-| [Perl 5](https://github.com/bk/Data-ULID) | [bk](https://github.com/bk) | ✓ |
-| [PHP](https://github.com/Lewiscowles1986/ulid) | [Lewiscowles1986](https://github.com/Lewiscowles1986) |
-| [PHP](https://github.com/robinvdvleuten/php-ulid) | [robinvdvleuten](https://github.com/robinvdvleuten) |
-| [PowerShell](https://github.com/PetterBomban/posh-ulid) | [PetterBomban](https://github.com/PetterBomban) |
-| [Python](https://github.com/mdipierro/ulid) | [mdipierro](https://github.com/mdipierro) |
-| [Python](https://github.com/ahawker/ulid) | [ahawker](https://github.com/ahawker) | ✓ |
-| [Python](https://github.com/mdomke/python-ulid) | [mdomke](https://github.com/mdomke) | ✓ |
-| [Ruby](https://github.com/rafaelsales/ulid) | [rafaelsales](https://github.com/rafaelsales) |
-| [Rust](https://github.com/mmacedoeu/rulid.rs) | [mmacedoeu](https://github.com/mmacedoeu/rulid.rs) | ✓ |
-| [Rust](https://github.com/dylanhart/ulid-rs) | [dylanhart](https://github.com/dylanhart) | ✓ |
-| [SQL-Microsoft](https://github.com/rmalayter/ulid-mssql) | [rmalayter](https://github.com/rmalayter) | ✓ |
-| [Swift](https://github.com/simonwhitehouse/ULIDSwift) | [simonwhitehouse](https://github.com/simonwhitehouse) |
-| [Tcl](https://wiki.tcl-lang.org/48827) | [dbohdan](https://github.com/dbohdan) |
+Refer to [ulid/spec](https://github.com/ulid/spec)
 
 ## Specification
 
-Below is the current specification of ULID as implemented in this repository.
-
-*Note: the binary format has not been implemented in JavaScript as of yet.*
-
-```
- 01AN4Z07BY      79KA1307SR9X4MV3
-
-|----------|    |----------------|
- Timestamp          Randomness
-   48bits             80bits
-```
-
-### Components
-
-**Timestamp**
-- 48 bit integer
-- UNIX-time in milliseconds
-- Won't run out of space till the year 10895 AD.
-
-**Randomness**
-- 80 bits
-- Cryptographically secure source of randomness, if possible
-
-### Sorting
-
-The left-most character must be sorted first, and the right-most character sorted last (lexical order). The default ASCII character set must be used. Within the same millisecond, sort order is not guaranteed
-
-### Canonical String Representation
-
-```
-ttttttttttrrrrrrrrrrrrrrrr
-
-where
-t is Timestamp (10 characters)
-r is Randomness (16 characters)
-```
-
-#### Encoding
-
-Crockford's Base32 is used as shown. This alphabet excludes the letters I, L, O, and U to avoid confusion and abuse.
-
-```
-0123456789ABCDEFGHJKMNPQRSTVWXYZ
-```
-
-### Monotonicity
-
-When generating a ULID within the same millisecond, we can provide some
-guarantees regarding sort order. Namely, if the same millisecond is detected, the `random` component is incremented by 1 bit in the least significant bit position (with carrying). For example:
-
-```javascript
-import { monotonicFactory } from 'ulid'
-
-const ulid = monotonicFactory()
-
-// Assume that these calls occur within the same millisecond
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVRZ
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVS0
-```
-
-If, in the extremely unlikely event that, you manage to generate more than 2<sup>80</sup> ULIDs within the same millisecond, or cause the random component to overflow with less, the generation will fail.
-
-```javascript
-import { monotonicFactory } from 'ulid'
-
-const ulid = monotonicFactory()
-
-// Assume that these calls occur within the same millisecond
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVRY
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVRZ
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVS0
-ulid() // 01BX5ZZKBKACTAV9WEVGEMMVS1
-...
-ulid() // 01BX5ZZKBKZZZZZZZZZZZZZZZX
-ulid() // 01BX5ZZKBKZZZZZZZZZZZZZZZY
-ulid() // 01BX5ZZKBKZZZZZZZZZZZZZZZZ
-ulid() // throw new Error()!
-```
-
-#### Overflow Errors when Parsing Base32 Strings
-
-Technically, a 26-character Base32 encoded string can contain 130 bits of information, whereas a ULID must only contain 128 bits. Therefore, the largest valid ULID encoded in Base32 is `7ZZZZZZZZZZZZZZZZZZZZZZZZZ`, which corresponds to an epoch time of `281474976710655` or `2 ^ 48 - 1`.
-
-Any attempt to decode or encode a ULID larger than this should be rejected by all implementations, to prevent overflow bugs.
-
-### Binary Layout and Byte Order
-
-The components are encoded as 16 octets. Each component is encoded with the Most Significant Byte first (network byte order).
-
-```
-0                   1                   2                   3
- 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|                      32_bit_uint_time_high                    |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|     16_bit_uint_time_low      |       16_bit_uint_random      |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|                       32_bit_uint_random                      |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-|                       32_bit_uint_random                      |
-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
-```
-
-## Prior Art
-
-Partly inspired by:
-- http://instagram-engineering.tumblr.com/post/10853187575/sharding-ids-at-instagram
-- https://firebase.googleblog.com/2015/02/the-2120-ways-to-ensure-unique_68.html
-
+Refer to [ulid/spec](https://github.com/ulid/spec)
 
 ## Test Suite
 

diff --git a/package.json b/package.json
@@ -7,14 +7,14 @@
   "types": "./lib/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/alizain/ulid.git"
+    "url": "git+https://github.com/ulid/javascript.git"
   },
   "author": "Alizain Feerasta",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/alizain/ulid/issues"
+    "url": "https://github.com/ulid/javascript/issues"
   },
-  "homepage": "https://github.com/alizain/ulid#readme",
+  "homepage": "https://github.com/ulid/javascript#readme",
   "devDependencies": {
     "@types/node": "^8.0.47",
     "babel-core": "^6.26.0",