Compare commits
2 commits
Author | SHA1 | Date | |
---|---|---|---|
40b348862a | |||
1af46c0aaf |
1 changed files with 14 additions and 3 deletions
17
README.md
17
README.md
|
@ -19,16 +19,27 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<p align="center">
|
<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" />
|
<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>
|
</p>
|
||||||
|
|
||||||
## Introduction
|
## Introduction
|
||||||
|
|
||||||
Sharkitek is a lightweight Javascript / TypeScript library designed to ease development of models.
|
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.
|
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`.
|
Then, you can use the defined methods like `serialize`, `parse`, `patch` or `serializeDiff`.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue