Merge pull request #1 from CraigFe/release-1.0.0

Release 1.0.0
mirage · Nov 19, 2020 · 043eba7 · 043eba7
2 parents 95ea1d5 + a270cea
commit 043eba7
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -0,0 +1,3 @@
+### 1.0.0 (2020-11-18)
+
+Initial release.
diff --git a/README.md b/README.md
@@ -1,12 +1,17 @@
 ## Compatibility `Either` module
-[![Build Status](https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Fmirage%2Feither%2Fmain&logo=ocaml)](https://ci.ocamllabs.io/github/mirage/either)
+[![OCaml-CI Build Status][ci-badge]][ci-status]
+[![Documentation](https://img.shields.io/badge/doc-online-blue.svg)][docs]
 
 Projects that want to use the `Either` module defined in OCaml 4.12.0 while
 staying compatible with older versions of OCaml should use this library
 instead.  On OCaml versions 4.12 and above, this library defines an alias
 `Either` to the standard library's definition of the module.  Otherwise, it
 provides an equivalent definition of `Either`.
 
+[ci-status]: https://ci.ocamllabs.io/github/mirage/either
+[ci-badge]: https://img.shields.io/endpoint?url=https%3A%2F%2Fci.ocamllabs.io%2Fbadge%2Fmirage%2Feither%2Fmain&logo=ocaml
+[docs]: https://docs.mirage.io/either/either/index.html
+
 #### Depending on this library
 
 Opam libraries depending on this module are encouraged to use a conditional

diff --git a/dune-project b/dune-project
@@ -6,7 +6,7 @@
 (authors "Craig Ferguson <me@craigfe.io>")
 (maintainers "Craig Ferguson <me@craigfe.io>")
 (source (github mirage/either))
-(documentation "https://docs.mirage.io/either")
+(documentation "https://mirage.github.io/either")
 
 (package
  (name either)

diff --git a/either.opam b/either.opam
@@ -10,7 +10,7 @@ maintainer: ["Craig Ferguson <me@craigfe.io>"]
 authors: ["Craig Ferguson <me@craigfe.io>"]
 license: "MIT"
 homepage: "https://github.com/mirage/either"
-doc: "https://docs.mirage.io/either"
+doc: "https://mirage.github.io/either"
 bug-reports: "https://github.com/mirage/either/issues"
 depends: [
   "dune" {>= "2.0"}