Updated examples in readme

DaniFoldi · Sep 2, 2020 · 049859f · 049859f
1 parent 105ea5e
commit 049859f
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -13,70 +13,70 @@ Then import it as usual with `#import <Async_Operations.h>`
 
 ## Basic usage
 
-#### Deferred execution
+#### Delayed execution
 ```c++
-#import <Async_Operations.h>
+#include <Async_Operations.h>
 
 long long dt = {1000};
-Async_Operations delayed(dt, 1, 1);
+Async_Operations delayed(&dt, 1, 1);
 
 void setup() {
-    pinMode(LED_BUILTIN, OUTPUT);
-    delayed.setLoopCallback(&cb);
-    delayed.start();
+  pinMode(LED_BUILTIN, OUTPUT);
+  delayed.setLoopCallback(&cb);
+  delayed.start();
 }
 
 void cb() {
-    digitalWrite(LED_BUILTIN, HIGH);
+  digitalWrite(LED_BUILTIN, HIGH);
 }
 
 void loop() {
-    delayed.update();
+  delayed.update();
 }
 ```
 
 #### Blinking LED
 
 ```c++
-#import <Async_Operations.h>
+#include <Async_Operations.h>
 
 long long dt = {500, 500};
-Async_Operations blinker(dt, 2, -1, LED_BUILTIN);
+Async_Operations blinker(&dt, 2, -1, LED_BUILTIN);
 
 void setup() {
-    blinker.start();
+  blinker.start();
 }
 
 void loop() {
-    blinker.update();
+  blinker.update();
 }
 ```
 
 #### Timeout handler
 
 ```c++
-#import <Async_Operations.h>
+#include <Async_Operations.h>
 
 long long dt = {10000};
-Async_Operations handler(dt, 1, 1);
+Async_Operations handler(&dt, 1, 1);
 
 bool waiting = false;
 int buttonPin = 10;
 
 void setup() {
-    handler.setLoopCallback(&resetWaiting)
-    pinMode(buttonPin, INPUT_PULLUP);
+  handler.setLoopCallback(&resetWaiting);
+  pinMode(buttonPin, INPUT_PULLUP);
 }
 
 void resetWaiting() {
-    waiting = false;
+  waiting = false;
 }
 
 void loop() {
-    if (digitalRead(buttonPin) == LOW) {
-        waiting = true;
-        handler.restart();
-    }
+  if (digitalRead(buttonPin) == LOW) {
+    waiting = true;
+    handler.restart();
+  }
 }
 ```
 

diff --git a/examples/BlinkingLed/BlinkingLed.ino b/examples/BlinkingLed/BlinkingLed.ino
@@ -1,18 +1,12 @@
 #include <Async_Operations.h>
 
-long long dt = {1000};
-Async_Operations delayed(dt, 1, 1);
+long long dt = {500, 500};
+Async_Operations blinker(&dt, 2, -1, LED_BUILTIN);
 
 void setup() {
-  pinMode(LED_BUILTIN, OUTPUT);
-  delayed.setLoopCallback(&cb);
-  delayed.start();
-}
-
-void cb() {
-  digitalWrite(LED_BUILTIN, HIGH);
+  blinker.start();
 }
 
 void loop() {
-  delayed.update();
+  blinker.update();
 }
diff --git a/examples/DelayedExecution/DelayedExecution.ino b/examples/DelayedExecution/DelayedExecution.ino
@@ -1,7 +1,7 @@
 #import <Async_Operations.h>
 
 long long dt = {1000};
-Async_Operations delayed(dt, 1, 1);
+Async_Operations delayed(&dt, 1, 1);
 
 void setup() {
   pinMode(LED_BUILTIN, OUTPUT);

diff --git a/examples/TimeoutHandler/TimeoutHandler.ino b/examples/TimeoutHandler/TimeoutHandler.ino
@@ -1,7 +1,7 @@
 #include <Async_Operations.h>
 
 long long dt = {10000};
-Async_Operations handler(dt, 1, 1);
+Async_Operations handler(&dt, 1, 1);
 
 bool waiting = false;
 int buttonPin = 10;

diff --git a/library.properties b/library.properties
@@ -1,5 +1,5 @@
 name=Async_Operations
-version=1.0.1
+version=1.0.2
 author=DaniFoldi
 maintainer=DaniFoldi
 sentence=A library for accurately keeping track of long tasks without blocking the main thread