Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
karmaniverous committed Aug 27, 2024
1 parent 95a9233 commit 20bec16
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,9 @@
![Why Serify?](./assets/flowchart.png)

**serify** - reversibly transform an unserializable value into a serializable one

**deserify** - do the exact opposite

---

**_BREAKING CHANGE:_** _The v2.0.0 release is a complete TypeScript refactor. The API now requires you to import & extend the [`defaultOptions`](./src/options/defaultOptions.ts) object to create custom types. See the [Options section](#options) for more info!_

---

## Why?

`JSON.stringify` and `JSON.parse` are a notoriously bad serializer/deserializer combination. They don't support important Javascript types like `BigInt`, `Date`, `Map`, `Set`, and `unknown`. Thanks to backward compatibility risk, they probably never will.
Expand Down
Binary file added assets/flowchart.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 20bec16

Please sign in to comment.