Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
FlorianFe authored Feb 24, 2018
1 parent 9860d59 commit 2b2b532
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,27 @@ A visualization web component for minecraft schematic files.
| texturePackPath | String | Path to the root of an unzipped texture pack |
| zoom | Number | Zoom level of the view (default is 1.0) |

## 🚀 Usage

1. Install package
```bash
bower install --save voxel-visualization
```

2. Import
```html
<link rel="import" href="bower_components/voxel-visualization/voxel-visualization.html">
```

3. Place in your HTML
```html
<voxel-visualization schematic-path="path/to/my/schematic/file.schematic"></voxel-visualization>
```

## 🖼 Preview
![Screenshot](https://florianfe.github.io/screenshots/voxel-visualization/screenshot.png)

## 🚀 Demo
## 👀 Demo
[See live demo here](https://florianfe.github.io/webcomponents/voxel-visualization/demo/)

## 🗒 Note
Expand Down

0 comments on commit 2b2b532

Please sign in to comment.