zipy-for-rd/README.md

SDK for zipy

# ZIPY SDK

The Javascript SDK for Zipy

## Installation

```bash
npm i zipyai
```

## Usage

```bash
import zipy from "zipyai";
Note: 1. Make sure you have install `brotli`, we are using it compress the build files
      2. While releasing npm package, make sure you change `isNPM` to `true` in config.json

zipy.init("<app-id>");
```
1. Run `npm run build`
2. brotli -k dist/zipy.min.umd.js
3. cp dist/zipy.min.umd.js.br dist/zipy.min.umd.js
4. Open bucket in which we have to upload SDK (create version folder first if not exist)
5. Create changelog.txt, update the file with release changes and upload to a bucket.
6. Upload SDK and map file in buckets (newly generated in the root folder: `./zipy.min.umd.js`)
7. Change edit metadata of SDK, enter `content-encoding` to `br`
8. Change edit metadata of SDK, enter `cache-control` to `public, max-age=3600`