# hscuid

[![Build Status](https://img.shields.io/travis/crabmusket/hscuid/master.svg?label=tests)](https://travis-ci.org/crabmusket/hscuid)
[![Hackage](https://img.shields.io/hackage/v/hscuid.svg)](https://hackage.haskell.org/package/hscuid)

A Haskell port of the [JavaScript library][cuid] for collision-resistant identifiers.
To install, [`cabal install hscuid`][hscuid].

## What is a CUID?

CUIDs are short random strings designed so that you can generate a lot of them over many different machines and not get collisions.
They are intended to be usable in situations from HTML element IDs to database keys.
You can read more about them at [usecuid.org][].

## How do I use this library?

```haskell
>>> import Web.Cuid (newCuid, newSlug)
>>> newCuid
"cib3c3tcu0000zwowx9ho2gh4"
>>> newSlug
"y900001wmf"
```

## Developing

I am currently developing with [stack][].
To install dependencies and compile the library and test suites:

```sh
stack build
```

To run the collision test suite (which generates 1.2M IDs and makes sure they're all unique):

```sh
stack test
```

To test performance with [criterion][]:

```sh
stack exec perf-test -- --regress allocated:iters +RTS -T
```

[cuid]: https://github.com/ericelliott/cuid
[hscuid]: https://hackage.haskell.org/package/hscuid
[semver]: http://semver.org
[usecuid.org]: https://usecuid.org
[criterion]: https://hackage.haskell.org/package/criterion
[stack]: https://haskellstack.org