Skip to content

Commit

Permalink
Update new NPM package information
Browse files Browse the repository at this point in the history
  • Loading branch information
andreyluiz committed Dec 12, 2024
1 parent f3775fb commit 46ad522
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
30 changes: 26 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
# Sia v2
# Sia

This package is getting a rewrite. The new version is incompatible with the previous one.
Sia serialization for JavaScript/TypeScript

See the [history](https://github.com/pouya-eghbali/sia/tree/f5cdb97bd45e2e1542a953f5c277500bc1526b86)
of this repository for more information.
## What is Sia?

Sia is the serialization library used by [Unchained](https://github.com/TimeleapLabs/unchained). Check more details on [Sia's official documentation](https://timeleap.swiss/docs/products/sia).

## Installation

```bash
npm install @timeleap/sia
```

## Usage

```python
import { Sia } from "@timeleap/sia";

const sia = new Sia();

sia
.addString8("Hello")
.addUint8(25)
.addAscii("World");

console.log(sia.content);
```
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sializer",
"version": "2.0.2",
"name": "@timeleap/sia",
"version": "2.1.0",
"description": "",
"main": "dist/index.js",
"typings": "dist/index.d.ts",
Expand Down

0 comments on commit 46ad522

Please sign in to comment.