Unverified Commit e9a79fea authored by zapashcanon's avatar zapashcanon
Browse files

add some boilerplate

parent ec5f65bf
## unreleased
- first release
The ISC License (ISC)
=====================
Copyright © 2021, OCamlPro
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
# swhid [![Actions Status](https://github.com/ocamlpro/osh/workflows/build/badge.svg)](https://github.com/ocamlpro/osh/actions) [![coverage percentage](https://raw.githubusercontent.com/ocamlpro/osh/gh-pages/coverage/badge.svg)](https://ocamlpro.github.io/osh/coverage/)
[osh] is an [OCaml] website, providing an API to generate SVG shields.
## Installation
`osh` can be installed with [opam]:
```sh
opam install osh
```
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
```ocaml
let () = TODO
```
For more, have a look at the [example] folder, at the [documentation] or at the [test suite].
## About
- [LICENSE]
- [CHANGELOG]
[CHANGELOG]: ./CHANGES.md
[example]: ./example/
[LICENSE]: ./LICENSE.md
[opam file]: ./osh.opam
[test suite]: ./test/
[documentation]: https://ocamlpro.github.io/osh/api/osh/
[how to install opam]: https://opam.ocaml.org/doc/Install.html
[OCaml]: https://ocaml.org
[opam]: https://opam.ocaml.org/
[swhid]: https://ocamlpro.github.io/osh/
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment