docs: adds deprecation message

losandes · May 25, 2024 · eeecb3d · eeecb3d
1 parent 43fa0b7
commit eeecb3d
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -43,6 +43,11 @@ jobs:
         npm i -g pnpm
         pnpm install
 
+    - name: Build the browser distro
+      env:
+        CI: true
+      run: pnpm run build
+
     - name: Run tests
       env:
         CI: true

diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
 # @polyn/blueprint
 
+## Deprecated
+
+Use [zod](https://zod.dev/) instead.
+
+This library served a purpose for years, but newer libraries like zod solve the problems this library set out to solve and many more for both JavaScript and TypeScript.
+
+---
+
 [![tests](https://github.com/losandes/polyn-blueprint/actions/workflows/pull-request.yml/badge.svg)](https://github.com/losandes/polyn-blueprint/actions/workflows/pull-request.yml)
 [![coverage](https://coveralls.io/repos/github/losandes/polyn-blueprint/badge.svg?branch=latest)](https://coveralls.io/github/losandes/polyn-blueprint?branch=latest)
 [![vulnerabilities](https://snyk.io/test/github/losandes/polyn-blueprint/badge.svg)](https://snyk.io/test/github/losandes/polyn-blueprint)