Skip to content

Commit

Permalink
Remove public package, add README.md entry.
Browse files Browse the repository at this point in the history
  • Loading branch information
toots committed Apr 13, 2023
1 parent 05caeef commit 2a6c15e
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 41 deletions.
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,21 @@ Please note that `dune install` installs the file under the same local directory
This option is meant to be used when packaging the library for distributions using binary packages such
as debian or ubuntu packages, RPM package etc.

## Migration form 1.x.x

The library's API was update and cleaned up in its version `2.0.0` as part of the migration to support OCaml `5.0.0`. As a
consequence, modules depending on the old library are now incompatible with the new library.
If you were previously using the `CamomileLibraryDefault` module, all you should have to do is
use the new top-level `Camomile` module.
If you were previously using the configuration functor to define your own library, you should be able to
use the new `Camomile.Make` functor available at top-level as well.
Otherwise, you can check the `compat/` directory of this repository. It contains a simple compatibility
library that you should be able to re-use in your code. We do, however, recommend simply updating your
code to the new API. It really shouldn't be too hard!

## Using libraries

### Configuration
Expand Down
34 changes: 0 additions & 34 deletions camomile-compat.opam

This file was deleted.

1 change: 0 additions & 1 deletion compat/dune
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,5 @@

(library
(name camomileCompat)
(public_name camomile-compat)
(libraries camomile camomile.lib)
(wrapped false))
6 changes: 0 additions & 6 deletions dune-project
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,3 @@ designed for Unicode Standard 3.2.")
(stdlib-random :with-test)
(ocaml (>= 4.13)))
(sites (share database) (share mappings) (share charmaps) (share locales)))

(package
(name camomile-compat)
(synopsis "Compatibility Camomile module")
(description "This module provides a backward-compatible API for projects depending on pre 2.0.0 Camomile API.")
(depends camomile))

0 comments on commit 2a6c15e

Please sign in to comment.