Skip to content

Commit 953fbd7

Browse files
committed
README.MD updates (more to come)
1 parent 031b749 commit 953fbd7

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,17 @@ Please see the [![License](https://img.shields.io/badge/License-Apache%202.0-blu
3434
## Namespace
3535
Every type/variable/constant/etc. related to *ESPressio* Event are located within the `Event` submaspace of the `ESPressio` parent namespace.
3636

37+
The namespace provides the following (*click on any declaration to navigate to more info*):
38+
- [`ESPressio::Event::IEvent`](#ievent)
39+
- [`ESPressio::Event::Event`](#event)
40+
- [`ESPressio::Event::IEventThread`](#ieventthread)
41+
- [`ESPressio::Event::EventThread`](#eventthread)
42+
43+
## Dependencies
44+
The ESPressio Event library has an internal dependency, which is the [`ESPressio Threads library`](http://github.com/Flowduino/ESPressio-Threads).
45+
46+
This library for Event-Driven Development (EDD) builds upon the Threading library directly, so please pay attention to include both libraries in your projects.
47+
3748
## Platformio.ini
3849
You can quickly and easily add this library to your project in PlatformIO by simply including the following in your `platformio.ini` file:
3950

@@ -46,3 +57,9 @@ lib_deps =
4657
Please note that this will use the very latest commits pushed into the repository, so volatility is possible.
4758
This will of course be resolved when the first release version is tagged and published.
4859
This section of the README will be updated concurrently with each release.
60+
61+
## What is "Event-Driven" Development?
62+
Event-Driven Development is a means of fully (and truly) decoupling your code from each distinct functionality.
63+
64+
By Dispatching "Events" (*through a Queue or a Stack, see later*) containing context-specific "payload" information, and having separate code *Listen* for those Events, we are able to ensure that no direct relationship need exist between either distinct functionality.
65+
In this way, distinct functionalities can be developed in total indepdenence of each other, and all that need be agreed are the Events that will be Dispatched and Received.

0 commit comments

Comments
 (0)