jyapayne/kiwi
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Ziang Song 2013-02-15 16:03:12 -05:00
commit 4cdf63c416
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -10,6 +10,7 @@ Example
```javascript ```javascript
Kiwi.compose(<input_string>, <array of the strings to interpolate>); Kiwi.compose(<input_string>, <array of the strings to interpolate>);
Kiwi.compose(<input_string>, <json object>);
``` ```
* Use **% (percentage symbol)** as the place holder. * Use **% (percentage symbol)** as the place holder.
@ -24,7 +25,7 @@ console.log(result);
``` ```
* Use **` (Grave accent symbol)** to escape the % symbol. * Use **` (grave accent symbol)** to escape the % symbol.
```javascript ```javascript
@ -36,13 +37,13 @@ console.log(result);
``` ```
* You can also do key-value interpolate like this * You can also do key-value interpolation like this
```javascript ```javascript
var input = "The quick brown %{f} jumps over the lazy %{d}."; var input = "The quick brown %{f} jumps over the lazy %{d}.";
var data = {"f": "fox", "d": "dog"}; var data_obj = {"f": "fox", "d": "dog"};
var result = Kiwi.compose(input, data); var result = Kiwi.compose(input, data_obj);
console.log(result); console.log(result);
//Output: The quick brown fox jumps over the lazy dog. //Output: The quick brown fox jumps over the lazy dog.