Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions docs/docs/embedding.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,26 @@ The above example shows the most basic usage of the `<kicanvas-embed>` element.

## Installation

### Pre-compiled

During alpha, the best way to install KiCanvas is to [download the bundled kicanvas.js](/kicanvas/kicanvas.js), copy it into your project, and include it with a script tag:

```html
<script type="module" src="/kicanvas.js"></script>
```

### Package installation

```bash
npm install --save https://github.com/theacodes/kicanvas
```

Ensure the package is imported somewhere like `main.ts` to enable the custom web elements.

```typescript
import "kicanvas";
```

## Examples

### Interactivity
Expand Down
10 changes: 10 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,17 @@
"name": "kicanvas",
"version": "0.0.0",
"description": "",
"main": "./src/index.ts",
"types": "./src/index.ts",
"exports": {
".": "./src/index.ts"
},
"type": "module",
"files": [
"src/**/*",
"README.md",
"LICENSE.md"
],
"directories": {
"test": "tests"
},
Expand Down