From f1cb33d9047082ae000f5778e79ba56af14d72d4 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Sun, 23 Jun 2019 01:32:42 +0200 Subject: [PATCH] some readme tweaks --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 6a08038..2da8eef 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Additionally, Coroutine provides the following features: # How to Use ## Setting up the CoroutineHandler -The `CoroutineHandler` is the place where coroutines get executed. For this to occur, the `Tick` method needs to be called continuously. This can either be done in your application's existing update loop or as follows: +The `CoroutineHandler` is the place where coroutines get executed. For this to occur, the `Tick` method needs to be called continuously. The `Tick` method takes a single parameter which represents the amount of seconds since the last time it was called. It can either be called in your application's existing update loop or as follows. ```cs var lastTime = DateTime.Now; while (true) { @@ -63,4 +63,7 @@ private static IEnumerator WaitForTestEvent() { To actually cause the event to be raised, causing all currently waiting coroutines to be continued, simply call `RaiseEvent`: ```cs CoroutineHandler.RaiseEvent(TestEvent); -``` \ No newline at end of file +``` + +## Additional Examples +For additional examples, take a look at the [Example class](https://github.com/Ellpeck/Coroutine/blob/master/Test/Example.cs). \ No newline at end of file