mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-06-17 13:15:21 +02:00
Updated README
This commit is contained in:
parent
fabff99316
commit
a97c137da1
|
@ -256,4 +256,3 @@ module.exports = function (grunt) {
|
||||||
}
|
}
|
||||||
|
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
13
README.md
13
README.md
|
@ -50,11 +50,17 @@ tf.init();
|
||||||
If the ``base_path`` property is not specified, it will default to ``/tablefilter`` directory:
|
If the ``base_path`` property is not specified, it will default to ``/tablefilter`` directory:
|
||||||
```shell
|
```shell
|
||||||
your-page.html
|
your-page.html
|
||||||
|-- tablefilter
|
|— tablefilter
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
If you are not familiar with ``Grunt`` visit this page: [gruntjs.com/getting-started](http://gruntjs.com/getting-started). Once ``Grunt`` is sorted out you can follow the instructions below.
|
This project requires node.js and Grunt to be installed:
|
||||||
|
- install [node.js])(https://nodejs.org/)
|
||||||
|
- install [gruntjs.com/getting-started](Grunt) from the command line using npm(comes with node.js):
|
||||||
|
```shell
|
||||||
|
npm install -g grunt-cli
|
||||||
|
```
|
||||||
|
Once ``Grunt`` is sorted out you can follow the instructions below.
|
||||||
Start by installing any dependencies.
|
Start by installing any dependencies.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
|
@ -73,8 +79,7 @@ Use the ``build`` task to generate a production build:
|
||||||
grunt build
|
grunt build
|
||||||
```
|
```
|
||||||
|
|
||||||
The ``default`` Grunt task will create a production build and also run the
|
The ``default`` Grunt task will create a production build, run the tests and finally generate the demos:
|
||||||
tests:
|
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
grunt
|
grunt
|
||||||
|
|
Loading…
Reference in a new issue