# swhid_core

[swhid_core] is an [OCaml] library to work with [persistent identifiers] used by [Software Heritage], also known as swhid. This is the core library, for most use cases you should use the [swhid library] instead.

## Installation

`swhid_core` can be installed with [opam]:

```sh
opam install swhid_core
```

If you don't have `opam`, you can install it following the [how to install opam] guide.

If you can't or don't want to use `opam`, consult the [opam file] for build instructions.

## Quickstart

Have a look at the [example] folder or at the [documentation].

## About

- [LICENSE]
- [CHANGELOG]

[CHANGELOG]: ./CHANGES.md
[example]: ./example
[LICENSE]: ./LICENSE.md
[opam file]: ./swhid_core.opam
[test suite]: ./test

[documentation]: https://ocamlpro.github.io/swhid_core/api/swhid_core/
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
[persistent identifiers]: https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html
[Software Heritage]: https://www.softwareheritage.org
[swhid library]: https://github.com/OCamlPro/swhid
[swhid_core]: https://github.com/OCamlPro/swhid_core
