Skip to content

Commit

Permalink
Prep for 2.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
nvie committed Feb 8, 2022
1 parent aa18164 commit c3d0b41
Show file tree
Hide file tree
Showing 8 changed files with 16 additions and 10 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## v2.0.0-beta
## v2.0.0

This is a breaking change, which brings numerous benefits:

Expand Down
2 changes: 1 addition & 1 deletion MIGRATING-v2.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ for this, and I'm happy to help 🙏 !

## 🏁 Checklist

1. Install `$ npm install decoders@beta`
1. Install `$ npm install decoders`
1. If applicable, uninstall debrief: `$ npm uninstall debrief`
1. If applicable, uninstall lemons: `$ npm uninstall lemons`
1. Stop "calling" decoders, see [instructions](#stop-calling-decoders).
Expand Down
7 changes: 3 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,6 @@ const user = userDecoder.verify(externalData);
<div id="uuidv1"></div>
<div id="uuidv4"></div>

Documentation for v1 can be found
[here](https://github.com/nvie/decoders/tree/v1.25.5#readme).
Documentation for v2 (currently in beta) can be found on
[https://decoders.cc](https://decoders.cc).
Documentation can be found on [https://decoders.cc](https://decoders.cc).
(Old v1 documentation can still be found
[here](https://github.com/nvie/decoders/tree/v1.25.5#readme).)
2 changes: 1 addition & 1 deletion docs/Decoder.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 10
---

<div style="margin: 0 0 30px 0; padding: 0px 20px; background: #fff8c5; border: 1px solid rgba(212,167,44,0.4); border-radius: 8px; font-size: 1.2em;">
<p>You're looking at the documentation for decoders <b>v2.x</b>, which is still in beta!<br />
<p>You're looking at the documentation for decoders <b>v2.x</b>!<br />
You can find <a href="https://github.com/nvie/decoders/tree/v1.25.5#readme">the old 1.x docs</a> here, or read the
<a href="https://github.com/nvie/decoders/blob/main/MIGRATING-v2.md">migration instructions</a>.
</p>
Expand Down
2 changes: 1 addition & 1 deletion docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ nav_order: 20
---

<div style="margin: 0 0 30px 0; padding: 0px 20px; background: #fff8c5; border: 1px solid rgba(212,167,44,0.4); border-radius: 8px; font-size: 1.2em;">
<p>You're looking at the documentation for decoders <b>v2.x</b>, which is still in beta!<br />
<p>You're looking at the documentation for decoders <b>v2.x</b>!<br />
You can find <a href="https://github.com/nvie/decoders/tree/v1.25.5#readme">the old 1.x docs</a> here, or read the
<a href="https://github.com/nvie/decoders/blob/main/MIGRATING-v2.md">migration instructions</a>.
</p>
Expand Down
7 changes: 7 additions & 0 deletions docs/building-your-own.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,13 @@ parent: Guides
nav_order: 10
---

<div style="margin: 0 0 30px 0; padding: 0px 20px; background: #fff8c5; border: 1px solid rgba(212,167,44,0.4); border-radius: 8px; font-size: 1.2em;">
<p>You're looking at the documentation for decoders <b>v2.x</b>!<br />
You can find <a href="https://github.com/nvie/decoders/tree/v1.25.5#readme">the old 1.x docs</a> here, or read the
<a href="https://github.com/nvie/decoders/blob/main/MIGRATING-v2.md">migration instructions</a>.
</p>
</div>

# Building your own custom decoders

When defining new decoders, it's important to understand the difference between what
Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ nav_order: 0
---

<div style="margin: 0 0 30px 0; padding: 0px 20px; background: #fff8c5; border: 1px solid rgba(212,167,44,0.4); border-radius: 8px; font-size: 1.2em;">
<p>You're looking at the documentation for decoders <b>v2.x</b>, which is still in beta!<br />
<p>You're looking at the documentation for decoders <b>v2.x</b>!<br />
You can find <a href="https://github.com/nvie/decoders/tree/v1.25.5#readme">the old 1.x docs</a> here, or read the
<a href="https://github.com/nvie/decoders/blob/main/MIGRATING-v2.md">migration instructions</a>.
</p>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "decoders",
"version": "2.0.0-beta13",
"version": "2.0.0",
"description": "Elegant and battle-tested validation library for type-safe input data (for TypeScript and Flow)",
"license": "MIT",
"repository": {
Expand Down

0 comments on commit c3d0b41

Please sign in to comment.