From e7e1a602a2cf12e4c441e1253ddfc4c7b55c7d21 Mon Sep 17 00:00:00 2001 From: Qqwy / Marten Date: Fri, 27 Sep 2024 08:41:27 +0200 Subject: [PATCH] Remove 'NOTE: this library is young' from README.md Fixes https://github.com/fpco/unliftio/issues/121 --- unliftio/README.md | 6 ------ 1 file changed, 6 deletions(-) diff --git a/unliftio/README.md b/unliftio/README.md index ff8de06..526d3bb 100644 --- a/unliftio/README.md +++ b/unliftio/README.md @@ -7,12 +7,6 @@ Provides the core `MonadUnliftIO` typeclass, a number of common instances, and a collection of common functions working with it. Not sure what the `MonadUnliftIO` typeclass is all about? Read on! -__NOTE__ This library is young, and will likely undergo some serious changes -over time. It's also very lightly tested. That said: the core concept of -`MonadUnliftIO` has been refined for years and is pretty solid, and even though -the code here is lightly tested, the vast majority of it is simply apply -`withUnliftIO` to existing functionality. Caveat emptor and all that. - __NOTE__ The `UnliftIO.Exception` module in this library changes the semantics of asynchronous exceptions to be in the style of the `safe-exceptions` package, which is orthogonal to the "unlifting" concept. While this change is an improvment in most cases, it means that `UnliftIO.Exception` is not always a drop-in replacement for `Control.Exception` in advanced exception handling code. See [Async exception safety](#async-exception-safety) for details. ## Quickstart