cspace-refname/README.md

CollectionSpace refname utilities

# cspace-refname


[![npm package](https://img.shields.io/npm/v/cspace-refname.svg)](https://www.npmjs.com/package/cspace-refname)
[![continuous integration](https://github.com/collectionspace/cspace-refname.js/actions/workflows/ci-js.yml/badge.svg?branch=master&event=push)](https://github.com/collectionspace/cspace-refname.js/actions/workflows/ci-js.yml)
[![codecov](https://codecov.io/gh/collectionspace/cspace-refname.js/branch/master/graph/badge.svg?token=MI8Y67Z9EB)](https://app.codecov.io/gh/collectionspace/cspace-refname.js)

This library provides utility functions for working with CollectionSpace [refnames](https://wiki.collectionspace.org/display/collectionspace/RefName).

## Installation

Using npm:

```
$ npm install cspace-refname
```

Using git:

```
$ git clone https://github.com/collectionspace/cspace-refname.js.git
$ cd cspace-refname.js
$ npm install
```

## Usage

See the [examples](https://github.com/collectionspace/cspace-refname.js/tree/master/examples) and [unit tests](https://github.com/collectionspace/cspace-refname.js/tree/master/test/specs) for examples of usage.

## About CollectionSpace

[CollectionSpace](http://www.collectionspace.org/) is a free, open-source collections management application for museums, historical societies, natural science collections, and more.