Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
parhammmm authored Nov 30, 2018
1 parent 6ee3fe8 commit 894c325
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,23 @@
Shared components for ScirisApps


# install the plugin
## Instalation

NOTE: Documentation on this is a WIP
**Step 1** Install the package using NPM

`npm install --save git+https://github.com/sciris/sciris-uikit.git`

**Step 2** install the plugin with Vue by added the following to your project (most likey in a `index.js`):

```
mport Vuex from 'vuex';
import ScirisUIKit from 'sciris-uikit';
Vue.use(ScirisUIKit, {
router: router
});
```

## Example `index.js`

```js
import Vuex from 'vuex';
Expand Down

0 comments on commit 894c325

Please sign in to comment.