git.iko.soy/rowtype-yoga/purescript-unique
on master help sign in
rowtype-yoga/purescript-unique/README.md
43 lines 2.4 kB history raw
1# Unique
3[![CI](https://github.com/rowtype-yoga/purescript-unique/workflows/CI/badge.svg?branch=master)](https://github.com/rowtype-yoga/purescript-unique/actions?query=workflow%3ACI+branch%3Amaster)
4[![Release](https://img.shields.io/github/release/rowtype-yoga/purescript-unique.svg)](https://github.com/rowtype-yoga/purescript-unique/releases)
5[![Pursuit](https://pursuit.purescript.org/packages/purescript-unique/badge)](https://pursuit.purescript.org/packages/purescript-unique)
6[![Maintainer: nsaunders](https://img.shields.io/badge/maintainer-nsaunders-teal.svg)](https://github.com/nsaunders)
8Data.Unique for PureScript.
10## Installation
12Install `unique` with [Spago](https://github.com/purescript/spago):
14```sh
15spago install unique
16```
18## Quick start
20The quick start hasn't been written yet (contributions are welcome!). The quick start covers a common, minimal use case for the library, whereas longer examples and tutorials are kept in the [docs directory](./docs).
22## Documentation
24`unique` documentation is stored in a few places:
261. Module documentation is [published on Pursuit](https://pursuit.purescript.org/packages/purescript-unique).
272. Written documentation is kept in the [docs directory](./docs).
283. Usage examples can be found in [the test suite](./test).
30If you get stuck, there are several ways to get help:
32- [Open an issue](https://github.com/rowtype-yoga/purescript-unique/issues) if you have encountered a bug or problem.
33- Ask general questions on the [PureScript Discourse](https://discourse.purescript.org) forum or the [PureScript Discord](https://discord.com/invite/sMqwYUbvz6) chat.
35## Contributing
37You can contribute to `unique` in several ways:
391. If you encounter a problem or have a question, please [open an issue](https://github.com/rowtype-yoga/purescript-unique/issues). We'll do our best to work with you to resolve or answer it.
412. If you would like to contribute code, tests, or documentation, please [read the contributor guide](./CONTRIBUTING.md). It's a short, helpful introduction to contributing to this library, including development instructions.
433. If you have written a library, tutorial, guide, or other resource based on this package, please share it on the [PureScript Discourse](https://discourse.purescript.org)! Writing libraries and learning resources are a great way to help this library succeed.