From 49e2c36673bfdd20af15ae327f262133c79b9e93 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20Lemaire?= Date: Mon, 14 Jan 2019 23:30:00 +0100 Subject: [PATCH] Updated README --- README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e934b35..923ed12 100644 --- a/README.md +++ b/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) [![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) -[![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 ----- @@ -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. -Usage example -------------- +Install +------- + + npm install tk-serializer + +Use +--- + +Suppose you have 2 classes Class1 and Class2, whose instances you want to serialize. ```typescript -import { Serializer } from "ts-serializer"; +import { Serializer } from "tk-serializer"; const namespace = { Class1,