From 33ecfb7c20629786e8fa1d0e7db0acf32069e9c7 Mon Sep 17 00:00:00 2001 From: Christoph Fricke Date: Sun, 26 Jan 2025 21:01:14 +0100 Subject: [PATCH] docs: add stability hint (#71) --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d25afb7..de2b3c3 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,11 @@ A tiny, type-safe wrapper around [MSW](https://mswjs.io) to add support for full type inference from OpenAPI schema definitions that are generated with [OpenAPI-TS](https://openapi-ts.pages.dev/introduction). +> _Please note that the lack of regular releases does not mean that OpenAPI-MSW +> is abandoned. It works very reliably and includes all the features I intended +> to include. I rely heavily on the package myself and will resolve future +> problems and incompatibilities._ + ## Installation You can install OpenAPI-MSW with this shell command: @@ -12,8 +17,8 @@ You can install OpenAPI-MSW with this shell command: npm i -D openapi-msw ``` -**Note:** This package has a peer-dependency to MSW **v2**. There is no plan to -provide backwards compatibility for MSW v1. +This package has a peer-dependency to MSW **v2**. There is no plan to provide +backwards compatibility for MSW v1. ## Usage Guide