Adding Example Use Code (#11)

brightdigit · Nov 27, 2023 · 485d9fd · 485d9fd
1 parent 71e4a96
commit 485d9fd
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -96,6 +96,11 @@ internal struct VirtualMachine: Loggable {
   internal typealias LoggingSystemType = BushelLogging
 
   internal static let loggingCategory: BushelLogging.Category = .machine
+
+  func run () {
+    Self.logger.debug("Starting Run")
+    ...
+  }
   ...
 }
 ```
@@ -113,7 +118,11 @@ Now you can simply use the _new_ `Loggable` type:
 ```swift
 internal struct VirtualMachine: BushelLoggable {
   internal static let loggingCategory: BushelLogging.Category = .machine
-  ...
+
+  func run () {
+    Self.logger.debug("Starting Run")
+    ...
+  }
 }
 ```
 
@@ -123,4 +132,4 @@ Further documentation is available at [the Swift Package Index.](https://swiftpa
 
 # License 
 
-This code is distributed under the MIT license. See the [LICENSE](https://github.com/brightdigit/FelinePine/LICENSE) file for more info.
+This code is distributed under the MIT license. See the [LICENSE](https://github.com/brightdigit/FelinePine/LICENSE) file for more info.
diff --git a/Sources/FelinePine/Documentation.docc/Documentation.md b/Sources/FelinePine/Documentation.docc/Documentation.md
@@ -64,6 +64,12 @@ internal struct VirtualMachine: Loggable {
   internal typealias LoggingSystemType = BushelLogging
 
   internal static let loggingCategory: BushelLogging.Category = .machine
+
+  func run () {
+    Self.logger.debug("Starting Run")
+    ...
+  }
+
   ...
 }
 ```
@@ -82,7 +88,11 @@ Now you can simply use the _new_ `Loggable` type:
 ```swift
 internal struct VirtualMachine: BushelLoggable {
   internal static let loggingCategory: BushelLogging.Category = .machine
-  ...
+
+  func run () {
+    Self.logger.debug("Starting Run")
+    ...
+  }
 }
 ```