Skip to content

Commit a4dcf6f

Browse files
committed
chore: update README with random example
1 parent 5d1c728 commit a4dcf6f

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,17 @@ ember install ember-fakerjs
2727

2828
### Helpers
2929

30-
The main helper is `faker-fake`. You can use this to generate content using the entire faker API.
30+
The list of helpers available are:
3131

32-
The addon ships with the following helpers: `faker-fake`, `faker-sentence`, `faker-sentences`, `faker-text`.
32+
- `faker-fake` use this to generate content by directly using the `faker` API
33+
- `random` utility that provides parameterized access to the `random` subsection of the `faker` API
34+
- `faker-text`, `faker-sentence`, `faker-sentences` - generate lorem content
3335

3436
Example usage:
3537

3638
```hbs
39+
{{random "number" max=100}}
40+
{{random "arrayelement" array("Link" "Ganon" "Zelda")}}
3741
{{faker-sentence 10}} {{!-- create a 10-word sentence --}}
3842
{{faker-sentences 5}} {{!-- create a 5-sentence string --}}
3943
<img src={{faker-fake "{{image.avatar}}"}} alt="avatar">

0 commit comments

Comments
 (0)