Skip to content

Commit

Permalink
Clarify async usage (#411)
Browse files Browse the repository at this point in the history
Fixes #343
  • Loading branch information
niekcandaele committed Jan 27, 2022
1 parent 1b1ac4a commit f6dc7cd
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,7 @@ clock.tick(15);

Upon executing the last line, an interesting fact about the
[Poblano](https://en.wikipedia.org/wiki/Poblano) will be printed synchronously to
the screen. If you want to simulate asynchronous behavior, you have to use your
imagination when calling the various functions.
the screen. If you want to simulate asynchronous behavior, please see the `async` function variants (eg `clock.tick(time)` vs `await clock.tickAsync(time)`).

The `next`, `runAll`, `runToFrame`, and `runToLast` methods are available to advance the clock. See the
API Reference for more details.
Expand Down

0 comments on commit f6dc7cd

Please sign in to comment.