# cuid CUID generator for OCaml.

For further information, please refer to http://usecuid.org ### Installation If available on OPAM, it's easily installed with: ```shell $ opam install cuid ``` Otherwise, this library is also installable using Dune within this root directory: ```shell $ dune install cuid ``` This `cuid` package is just an alias/wrapper around the `cuid-unix` package, there is a JavaScript-target package called `cuid-jv` as well. ### Usage As library: ```ocaml let cuid = Cuid.generate ( ) (* cuid is "c00p6veue0000072slgr067a3", for example *) ``` There's also an implementation of CUID slugs. They fit in cases where _collision-resistance is not important_ and when they are not generated too frequently. For instance, we can use them as URL suffixes for blog posts. To generate a CUID slug, just use: ```ocaml let slug = Cuid.slug ( ) (* slug is "u90m0y0m", for example *) ``` For the `cuid-unix` internal package, the main module is called `Cuid_unix`, while the `cuid-jv` exposes the main module `Cuid_jv`. ### Conclusion PRs & issues are welcome. Have fun and imagine Sisyphus happy.