mirror of
https://github.com/koalyptus/TableFilter.git
synced 2024-05-20 15:26:40 +02:00
Updated the readme
This commit is contained in:
parent
e9ca72fdc2
commit
4240d3ca56
33
README.md
33
README.md
|
@ -24,12 +24,43 @@ solution
|
||||||
* Exhaustive documentation and API
|
* Exhaustive documentation and API
|
||||||
* Valuable support provided under a Premium request
|
* Valuable support provided under a Premium request
|
||||||
|
|
||||||
##Install
|
##Development
|
||||||
Start by installing any dependencies.
|
Start by installing any dependencies.
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
Use the Grunt ``dev`` task to launch a build / watch cycle and start the local
|
||||||
|
sever on port ``8080``:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
grunt dev
|
||||||
|
```
|
||||||
|
|
||||||
|
or the ``build`` task for a production build:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
grunt build
|
||||||
|
```
|
||||||
|
|
||||||
|
The ``default`` Grunt task will create a production build and also run the
|
||||||
|
tests:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
grunt
|
||||||
|
```
|
||||||
|
|
||||||
|
To run all the tests:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
grunt test
|
||||||
|
```
|
||||||
|
|
||||||
|
and to run a specific test:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
grunt test-only:test.html
|
||||||
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue