Updated README
This commit is contained in:
parent
32008ae7c4
commit
49e2c36673
15
README.md
15
README.md
|
@ -4,7 +4,7 @@ tk-serializer
|
||||||
[![Build status](https://img.shields.io/travis/thunderk/tk-serializer.svg)](https://travis-ci.org/thunderk/tk-serializer)
|
[![Build status](https://img.shields.io/travis/thunderk/tk-serializer.svg)](https://travis-ci.org/thunderk/tk-serializer)
|
||||||
[![Code coverage](https://img.shields.io/codecov/c/github/thunderk/tk-serializer.svg)](https://codecov.io/gh/thunderk/tk-serializer)
|
[![Code coverage](https://img.shields.io/codecov/c/github/thunderk/tk-serializer.svg)](https://codecov.io/gh/thunderk/tk-serializer)
|
||||||
[![NPM version](https://img.shields.io/npm/v/tk-serializer.svg)](https://www.npmjs.com/package/tk-serializer)
|
[![NPM version](https://img.shields.io/npm/v/tk-serializer.svg)](https://www.npmjs.com/package/tk-serializer)
|
||||||
[![Minified size](https://img.shields.io/bundlephobia/min/tk-serializer.svg)](https://bundlephobia.com/result?p=tk-serializer@1.0.0)
|
[![Minified size](https://img.shields.io/bundlephobia/min/tk-serializer.svg)](https://bundlephobia.com/result?p=tk-serializer)
|
||||||
|
|
||||||
About
|
About
|
||||||
-----
|
-----
|
||||||
|
@ -15,11 +15,18 @@ Deep objects state may be serialized to a string, and reconstructed back.
|
||||||
|
|
||||||
Class instances are reconstructed properly, as long as they are in the provided namespace. Circular references are handled.
|
Class instances are reconstructed properly, as long as they are in the provided namespace. Circular references are handled.
|
||||||
|
|
||||||
Usage example
|
Install
|
||||||
-------------
|
-------
|
||||||
|
|
||||||
|
npm install tk-serializer
|
||||||
|
|
||||||
|
Use
|
||||||
|
---
|
||||||
|
|
||||||
|
Suppose you have 2 classes Class1 and Class2, whose instances you want to serialize.
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
import { Serializer } from "ts-serializer";
|
import { Serializer } from "tk-serializer";
|
||||||
|
|
||||||
const namespace = {
|
const namespace = {
|
||||||
Class1,
|
Class1,
|
||||||
|
|
Loading…
Reference in a new issue