Update documentation to include details on running example

thedjpetersen · Dec 7, 2023 · 3db892e · 3db892e
1 parent 7821d32
commit 3db892e
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -109,6 +109,8 @@ Use this space to show useful examples of how a project can be used. Additional
 
 _For a full usage example please checkout the example listed in the [examples directory](https://github.com/thedjpetersen/flow-like-water/tree/main/examples)_
 
+_You can run the example code by running `npm run example` from the root directory_
+
 ```typescript
 // Import the necessary classes from the library
 import { Task, TaskGroup, FlowControl } from "./your-library-path";