README
Grout
Client library to simplify communication with Tessellate application building service.
Getting Started
Grout is isomorphic, so it can be used within a front-end or on a server. Below are options for setups:
NodeJS
Install:
npm install --save kyper-grout
Include and use
kyper-grout
:var Grout = require('kyper-grout');
var grout = new Grout();
### ES6
1. Install:
`npm install --save kyper-grout`
2. Include and use `kyper-grout`:
```javascript
import Grout from 'kyper-grout';
let grout = new Grout();
```
### Browser
1. Include the Grout library using one of the following:
#### CDN
Add script tag to index.html:
```html
<script src="http://cdn.kyper.io/js/grout/latest/grout.js"></script>
```
#### Bower
Run `bower install --save kyper-grout`
Then include the following in your index.html:
```html
<script src="./bower_components/kyper-grout/dist/grout.js"></script>
```
2. Begin using grout:
```javascript
var grout = new Grout();
if(grout.isLoggedIn){
console.log('The currently logged in user is', grout.currentUser);
} else {
console.warn('Not logged into grout');
}
```
## Documentation
### [API Documentation](https://github.com/KyperTech/grout/wiki/API-Documentation)
### [Main Wiki](https://github.com/KyperTech/grout/wiki)