Compare commits

...

2 commits
v4.0.0 ... main

Author SHA1 Message Date
40b348862a
Add package installation command in README.
All checks were successful
/ test (push) Successful in 22s
2025-03-30 13:16:00 +02:00
1af46c0aaf
Update badges.
All checks were successful
/ test (push) Successful in 21s
2025-03-30 13:09:31 +02:00

View file

@ -19,16 +19,27 @@
</p>
<p align="center">
<a href="https://www.npmjs.com/package/@sharkitek/core" target="_blank">
<img alt="Latest release" src="https://code.zeptotech.net/Sharkitek/Core/badges/release.svg" />
</a>
<img alt="Tests status" src="https://code.zeptotech.net/Sharkitek/Core/badges/workflows/test.yaml/badge.svg" />
<a href="https://bundlephobia.com/package/@sharkitek/core" target="_blank">
<img alt="Bundle size" src="https://badgen.net/bundlephobia/minzip/@sharkitek/core" />
</a>
<a href="https://www.npmjs.com/package/@sharkitek/core" target="_blank">
<img alt="Latest release" src="https://badgen.net/npm/v/@sharkitek/core" />
</a>
<a href="https://bundlephobia.com/package/@sharkitek/core" target="_blank">
<img alt="Bundle size" src="https://badgen.net/bundlephobia/dependency-count/@sharkitek/core" />
</a>
<img alt="Latest release" src="https://badgen.net/npm/types/@sharkitek/core" />
</p>
## Introduction
Sharkitek is a lightweight Javascript / TypeScript library designed to ease development of models.
```shell
yarn add @sharkitek/core
```
With Sharkitek, you define the architecture of your models by specifying their properties and their types.
Then, you can use the defined methods like `serialize`, `parse`, `patch` or `serializeDiff`.