Add (barebones) README

Taken from the company template.
ocurrent · Sep 16, 2024 · fe3299a · fe3299a
1 parent a11fe1f
commit fe3299a
Show file tree

Hide file tree

Showing 2 changed files with 32 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,31 @@
+# opam-ci-check
+
+## Synopsis
+
+A CLI tool that tests whether packages are publishable on the opam repository.
+
+This tool is in progress.
+
+## Installation
+
+``` sh
+opam install https://github.com/ocurrent/opam-ci-check.git
+```
+
+## Documentation
+
+https://www.ocurrent.org/opam-ci-check/
+
+## Contribution
+
+Contributions are most welcome!
+
+<!-- TODO -->
+- [File issues](https://github.com/ocurrent/opam-ci-check/issues) to report bugs or feature requests.
+- [Contribute code or documentation](./CONTRIBUTING.md)
+
+---
+
+This project is created and maintained by\
+<a href="https://tarides.com/"><img src="./Tarides.svg" width="200" alt="Tarides" /></a>
+
diff --git a/Tarides.svg b/Tarides.svg