Skip to content

Commit

Permalink
docs(README): declare the versioning policy
Browse files Browse the repository at this point in the history
  • Loading branch information
favonia committed Oct 31, 2023
1 parent 79fd268 commit feba970
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

This library aims to collect reusable, general effects-based components we have seen when constructing our proof assistants using OCaml 5. All components here have appeared in various tutorials on algebraic effects; `algaeff` wraps these well-known components into an OPAM package.

## API Stability

We use [semantic versioning.](https://semver.org/) Breaking changes will bump the major version number.

## Components

- [Algaeff.State](https://redprl.org/algaeff/algaeff/Algaeff/State): mutable states
Expand All @@ -16,7 +20,7 @@ Effects-based concurrency (cooperative lightweight threading) was already tackle
There are a few other useful functions:

- [Algaeff.Fun.Deep.finally](https://redprl.org/algaeff/algaeff/Algaeff/Fun/Deep/index.html#val-finally): call `continue` or `discontinue` accordingly.
- [Algaeff.Fun.Shallow.finally\_with](https://redprl.org/algaeff/algaeff/Algaeff/Fun/Shallow/index.html#val-finally_with): same as above, but for shallow effect handlers.
- [Algaeff.Fun.Shallow.finally_with](https://redprl.org/algaeff/algaeff/Algaeff/Fun/Shallow/index.html#val-finally_with): same as above, but for shallow effect handlers.

## How to Use It

Expand Down

0 comments on commit feba970

Please sign in to comment.