Skip to content

Commit

Permalink
Update release history, cleanup.
Browse files Browse the repository at this point in the history
  • Loading branch information
kennethcachia committed Feb 19, 2014
1 parent 1f260ba commit c321497
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@

# grunt-todo-server

> Grunt todo server.


## Getting Started
This plugin requires Grunt `~0.4.2`

Expand All @@ -17,6 +20,8 @@ Once the plugin has been installed, it may be enabled inside your Gruntfile with
grunt.loadNpmTasks('grunt-todo-server');
```



## The "todo_server_extract" task
In your project's Gruntfile, add a section named `todo_server_extract` to the data object passed into `grunt.initConfig()`.

Expand All @@ -41,6 +46,8 @@ Default value: `todo_server`

The folder used when generating static files and todo data.



## The "todo_server_start" task
In your project's Gruntfile, add a section named `todo_server_start` to the data object passed into `grunt.initConfig()`.

Expand Down Expand Up @@ -80,6 +87,8 @@ Default value: `todo_server`

The folder used by the webserver.



## Examples

#### Default Options
Expand All @@ -100,10 +109,15 @@ grunt.initConfig({
});
```


## Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).



## Todo

- Simplify options, merge tasks(?)
- Add an option to control the regex used during extraction
- Refresh the page automatically when `todo_server_extract` finishes
Expand All @@ -112,5 +126,8 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
- Add more themes
- Tests



## Release History
_(Nothing yet)_

* 2014-01-18   v0.1.0   Initial release.

0 comments on commit c321497

Please sign in to comment.