Skip to content

Commit

Permalink
📃 docs(README): Update README
Browse files Browse the repository at this point in the history
1. Add badges from shields.io.
2. Update screenshot to a more describable one.
3. Change TS Playground link to a StackBlitz one.
  • Loading branch information
Snowflyt committed Apr 27, 2024
1 parent 18d0321 commit 6b87ab0
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,21 @@
Create <strong><i>runtime-validated</i> functions</strong> with ease, featuring <strong>smart type inference</strong> in TypeScript.
</p>

<p align="center">
<a href="https://www.npmjs.com/package/safunc">
<img src="https://img.shields.io/npm/v/safunc.svg" alt="npm version" height="18">
</a>
<a href="https://bundlephobia.com/package/safunc">
<img src="https://img.shields.io/bundlephobia/minzip/safunc.svg" alt="minzipped size" height="18">
</a>
<a href="https://github.com/gvergnaud/safunc">
<img src="https://img.shields.io/npm/l/safunc.svg" alt="MIT license" height="18">
</a>
</p>

![screenshot](./screenshot.svg)

Have a try on [TS Playground](https://www.typescriptlang.org/play/?#code/JYWwDg9gTgLgBAbzgEwKYDMA0cDOwDm2MAnmKnAMoFwC+c6UEIcARDgIboCuAdgMYsA3AChhfCDxzwo7HvnIBeFBgAUwuHAD0mjQD0A-OtwEVLYDxip5UFthYKAfLdbnL1gNoBdFgEo47HEoCAB4VKQgwAC44Hi4QACNUKD9HGLjEqC8HTCM8fFNXKyTnMwsimzt9QusHAAYSxxLqpK9ff0CqfGCjDTCYdlho2ISk7HCotJGoMcswfSH0pJSHSYyvI2yjbn4YYAk4GTlUPoGYAHkoChgImYj9GdQwOCUARj8EHq0dDT1DH7hxJJ4FJTs9cNcngooXBeGh0OZUMg4Po4LU4NEQbALlcIiJ-uNkfolJjzpcIXiflBUDAuFAeHAAIJQGTEAB0DCYKiQABtUHIYAALaIAWXYgtZfFQwG5Kj6ETgAFpwac-DopI8-DRsCoAPrYYDLZWwOAAajgwDgACpwRqKVrhD4RMJDvJTOgIBBfCIXccACwAJjs8QGXuEQA).
Have a try on [StackBlitz](https://stackblitz.com/edit/safunc-minimal-example?file=main.ts&view=editor)!

## About

Expand Down
2 changes: 1 addition & 1 deletion screenshot.svg
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 6b87ab0

Please sign in to comment.