Skip to content

Commit

Permalink
doc(README): basic description
Browse files Browse the repository at this point in the history
  • Loading branch information
grzhan committed Sep 26, 2017
1 parent 089af90 commit 0494e50
Showing 1 changed file with 86 additions and 1 deletion.
87 changes: 86 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,91 @@

> A Vue component for [flat surface shader](https://github.com/wagerfield/flat-surface-shader)
## Build Setup
## How to use

```bash
npm install --save vue-flat-surface-shader
```

#### Main.js

```javascript
import Vue from 'vue'
import FlatSurfaceShader from 'vue-flat-surface-shader'

Vue.use(FlatSurfaceShader)
```

#### App.vue file (simple example)

```vue
<template>
<div id="app">
<flat-surface-shader type="webgl" :light="{ambient: '#22bc9e', diffuse: '#2b7c6b'}">
</flat-surface-shader>
</div>
</template>
```

#### App.vue file (advanced example)

```vue
<template>
<div id="app">
<flat-surface-shader type="canvas" :light="{ambient: '#22bc9e', diffuse: '#2b7c6b', draw: false}" :mesh="{segments: 4, slices: 4, width: 1.8, height: 1.8}">
</flat-surface-shader>
</div>
</template>
```

### Props

**1. Type**

+ The type of shader's renderer, avaliable values are `webgl`, `canvas`, `svg`.
+ Prop type: `String`
+ Default value: `webgl`

**2. Light**

| Name | Type | Default |
| ----------- | ------- | --------- |
| count | Number | 2 |
| xyScalar | Number | 1 |
| zOffset | Number | 100 |
| ambient | String | '#880066' |
| diffuse | String | '#FF8800' |
| speed | Number | 0.001 |
| gravity | Number | 1200 |
| dampening | Number | 0.95 |
| minLimit | Number | 10 |
| maxLimit | Number | null |
| minDistance | Number | 20 |
| maxDistance | Number | 400 |
| autopilot | Boolean | false |
| draw | Boolean | true |

For detailed explanation, see [http://wagerfield.github.io/flat-surf…](http://wagerfield.github.io/flat-surface-shader/)

**3. Mesh**

| Name | Type | Default |
| -------- | ------ | --------- |
| width | Number | 1.2 |
| height | Number | 1.2 |
| depth | Number | 10 |
| segments | Number | 16 |
| slices | Number | 8 |
| xRange | Number | 0.8 |
| yRange | Number | 0.1 |
| zRange | Number | 1.0 |
| ambient | String | '#555555' |
| diffuse | String | '#FFFFFF' |
| speed | Number | 0.002 |

For detailed explanation, see [http://wagerfield.github.io/flat-surf…](http://wagerfield.github.io/flat-surface-shader/)

## Development Build Setup

``` bash
# install dependencies
Expand All @@ -16,3 +100,4 @@ npm run build
```

For detailed explanation on how things work, consult the [docs for vue-loader](http://vuejs.github.io/vue-loader).

0 comments on commit 0494e50

Please sign in to comment.