Skip to content

Commit

Permalink
Fixing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mrodrig committed Mar 16, 2015
1 parent b40c794 commit 148af36
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ var tagCloud = require('tag-cloud');
* `classPrefix` - String - Class prefix for the tag classes that are generated [Default: 'bucket']
* `additionalAttributes` - Document - A JSON document specifying any additional values that you would like to be added to the tag's HTML as an attribute [Default: {}]
* If you would like to customize one of the fields to include the tag's text in the value, just use {{tag}} which will be replaced by the actual tag.
* Example: ```javascript {href: 'http://google.com?q={{tag}}'}```
* Example: ```{href: 'http://google.com?q={{tag}}'}```
* If your tags include special characters (ie. C#) and you need to use the tag in a URL, then you can specify the value as an Object
* Example: ```javascript { href : { encode : true, value: 'http://google.com?q={{tag}}' } } ```
* Example: ```{ href : { encode : true, value: 'http://google.com?q={{tag}}' } } ```

##### tagCloud Example:

Expand Down

0 comments on commit 148af36

Please sign in to comment.