From f9c4673713015cd69d94d1b7befafad0975e72fc Mon Sep 17 00:00:00 2001
From: novacbn <31122674+novacbn@users.noreply.github.com>
Date: Mon, 18 May 2020 21:22:10 -0400
Subject: [PATCH] - Updated docs

---
 src/stores/browser/query_param.ts |  2 +-
 src/util/shared/event.ts          | 24 ++++++++++++++++++++++++
 2 files changed, 25 insertions(+), 1 deletion(-)

diff --git a/src/stores/browser/query_param.ts b/src/stores/browser/query_param.ts
index 2ba724c..b1aef97 100644
--- a/src/stores/browser/query_param.ts
+++ b/src/stores/browser/query_param.ts
@@ -37,7 +37,7 @@ function QueryParamOptions(options: Partial<IQueryParamOptions> = {}): IQueryPar
 /**
  * Returns a `Writable` Svelte Store, which binds to a specific query string parameter
  *
- * ```javascript
+ * ```html
  * <script context="module">
  *     const SORTING_MODES = {
  *         ascending: "ASCENDING",
diff --git a/src/util/shared/event.ts b/src/util/shared/event.ts
index 82a52e6..ea90ccb 100644
--- a/src/util/shared/event.ts
+++ b/src/util/shared/event.ts
@@ -37,6 +37,30 @@ export interface IEvent<T> {
 
 /**
  * Returns a new [[IEvent]] instance, for handling event publishing in non-DOM related contexts
+ *
+ * As a minimal example:
+ *
+ * ```javascript
+ * import {event} from "svelte-commons/lib/util/event";
+ *
+ * // Initialize our event publisher as a singleton
+ * const MY_EVENT = event((dispatch) => {
+ *     // The callback we provided, will run whenever we get a first subscriber
+ *     console.log("Got my first subscriber!");
+ *
+ *     return () => {
+ *         // And the callback returned, will run whenever we lose our last subscriber
+ *         console.log("Lost my last subscriber!");
+ *     };
+ * });
+ *
+ * MY_EVENT.subscribe((details) => {
+ *     console.log(details);
+ * }); // Will log any dispatches to the event publisher
+ *
+ * MY_EVENT.dispatch({message: "Hello world!"}); // logs: `{"message": "Hello world!"}`
+ * ```
+ *
  * @param start
  */
 export function event<T>(start: IEventNotifier<T>): IEvent<T> {