diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..34bffce --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,16 @@ +## 1.4.0 +*Compatibility: Dust >= 2.4.0 < 2.6* + + - [contextDump] encode opening brackets + +## 1.3.0 +*Compatibility: Dust 2.4* + + - [core] fix loading helpers in Node + - [core] `dust.log()` support + - [core] make `dustjs-linkedin` a peerDependency + +## 1.2.0 +*Compatibility: Dust 2.3* + + - [tap] allow tap to be called on functions passed as parameters diff --git a/README.md b/README.md index 86d9079..c4c010a 100644 --- a/README.md +++ b/README.md @@ -1,54 +1,18 @@ # Dust Helpers [![Build Status](https://secure.travis-ci.org/linkedin/dustjs-helpers.png)](http://travis-ci.org/linkedin/dustjs-helpers) -Additional functionality for [dustjs-linkedin](http://linkedin.github.com/dustjs/) package -Read more here : +This repository holds context helpers for Dust. -## Getting Started -A quick tutorial for how to use Dust - -## Contributing -* Open https://github.com/linkedin/dustjs-helpers in a browser and fork it. Then clone your fork: - - git clone https://github.com//dustjs-helpers dustjs-helpers - cd dustjs-helpers - -* Set up a branch for what you are working on - - git checkout -b myBranchName - -* Install Grunt-cli, it lets you run `grunt` commands. For more information see - - npm install -g grunt-cli +Context helpers are augments to the core Dust template syntax. +It's possible to write your own helpers and extend the functionality of Dust's templating system. -* Install node dependencies needed for development in this project +The helpers we provide as part of this repository fulfill some of the most common use cases encountered while using Dust. +We provide official support for these helpers as part of the core Dust library. - npm install +Read the wiki for more information: -* Make your changes on the branch and run jshint\tests to make sure changes are OK - - grunt test - -* Commit your changes and push them to github - - git add . - git commit -m "My changes to dustjs-helpers repo" - git push origin myBranchName - -* Go to github and post a pull request, see - -## Debugging -To debug code in a browser run `grunt dev` task. It will generate jasmine spec runner and serve it on `http://localhost:3000/_SpecRunner.html` URL. -Generated spec runner references unminified dust-helpers.js and dust-full.js files. This will allow you to easily step through the code and set up breakpoints. -This task also watches changes to lib directory, so you can simply refresh the page to see the changes without a need to re-run `grunt dev` task. Press `Ctrl + C` to disconnect from server. - -## Using watch -`grunt watch` will monitor dust-helpers.js and test spec files. Whenever change is made to those files, it will jshint them and run unit tests in Phantom (will not run them in node or rhino). - It is handy way to keep testing your changes without a need to manually run `grunt testPhantom` task. - Be sure to run `grunt test` before sending pull request. It will test your change in all environments and make sure that a travis build for your pull request succeeds. +## Getting Started +The helpers depend on and augment Dust.js.If you need a refresher, read a [quick tutorial on using Dust](https://github.com/linkedin/dustjs/wiki/Dust-Tutorial). -## Testing minified code in browser -Use `grunt testClient` to test prod version code in any browser. Similarly to `grunt dev` task it will host spec runner on `http://localhost:3000/_SpecRunner.html` URL. +You can look at a [list of the helpers](https://github.com/linkedin/dustjs-helpers/wiki/Helpers) contained in this package, along with usage examples, on the wiki. -## Coverage report -Task `grunt coverage` runs jasmine unit tests against unminified source code and generates coverage report under `tmp/coverage` folder. -Open `index.html` file in a browser to view the coverage. \ No newline at end of file +The [changelog](https://github.com/linkedin/dustjs-helpers/blob/master/CHANGELOG.md) documents all added, deprecated, and removed functionality.