diff --git a/docs/api/event.md b/docs/api/event.md new file mode 100644 index 0000000..4d45d9e --- /dev/null +++ b/docs/api/event.md @@ -0,0 +1,7 @@ +Event +===== + +## The `Event` type + +The `Event` type is at the core of the libsnooze system and is what provides the "wait/notify" mechanism, i.e. a group of threads _wait_ +on an `Event` and another thread _notifies_ that `Event` to wake those waiting threads up. \ No newline at end of file diff --git a/docs/api.md b/docs/api/index.md similarity index 54% rename from docs/api.md rename to docs/api/index.md index 29b77fb..23b0610 100644 --- a/docs/api.md +++ b/docs/api/index.md @@ -5,10 +5,7 @@ There isn't all too much in terms of the methods exposed via the API as the func are, however, some methods of interest and some important things to note when using them. -## The `Event` type -The `Event` type is at the core of the libsnooze system and is what provides the "wait/notify" mechanism, i.e. a group of threads _wait_ -on an `Event` and another thread _notifies_ that `Event` to wake those waiting threads up. ## Methods diff --git a/docs/api/usage.md b/docs/api/usage.md new file mode 100644 index 0000000..ca629fe --- /dev/null +++ b/docs/api/usage.md @@ -0,0 +1,4 @@ +Usage +===== + +We'll now make an example that uses these ideas of the `Event` type and its associated objects. \ No newline at end of file