Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
kmkzt committed May 16, 2020
1 parent f204971 commit 4cf8f8f
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,40 @@

[![npm version](https://badge.fury.io/js/svg-drawing.svg)](https://www.npmjs.com/package/svg-drawing) [![npm download](https://img.shields.io/npm/dt/svg-drawing.svg)](https://www.npmjs.com/package/svg-drawing)

### introduction

`svg-drawing` is svg based drawing library with lightweight, no dependencies.

**[demo](https://kmkzt.github.io/svg-drawing/)**
[example code](src/example/)
This is a **[demo](https://kmkzt.github.io/svg-drawing/)**.

## Install

### npm

```shell
yarn add svg-drawing
# or
# npm i svg-drawing
```

Example code is [here](src/example/)

### CDN

```html
<!-- Common JS-->
<script src="https://unpkg.com/[email protected]/lib/index.min.js"></script>

<!-- ES Modules -->
<script type="module">
import {
SvgDrawing,
SvgAnimation
} from 'https://unpkg.com/[email protected]/lib/index.esm.js'
...
</script>
```

[Here](example/) is an example for Html only.

## How to use

### Drawing Example
Expand Down

0 comments on commit 4cf8f8f

Please sign in to comment.