Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdrone committed Oct 8, 2017
1 parent 8b91a41 commit 0175a95
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,15 +289,18 @@ Changes in the collection results in fine grain table changes (add/remove/move c

When the app is run in the simulator it is possible to inspect Render components, their properties and state with the [inspector companion mac app](https://github.com/alexdrone/Render/raw/master/inspector/dist/render-inspector.zip).

To enable the debug server in your app you simply have to call `startDebugServer()` in your AppDelegate `application(_:didFinishLaunchingWithOptions)`.
To enable the debug server in your app you simply have to import the `RenderInspector` framework and call `startRenderInspectorServer()` in your AppDelegate `application(_:didFinishLaunchingWithOptions)`.

```swift

import Render
import RenderInspector

class AppDelegate: UIResponder, UIApplicationDelegate {

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {
/// Starts the debug server at localhost:8080/inspect
startDebugServer()
startRenderInspectorServer()
...
}
```
Expand Down
2 changes: 1 addition & 1 deletion RenderInspector/Inspector.swift
Original file line number Diff line number Diff line change
Expand Up @@ -216,6 +216,6 @@ public final class NilInspector: InspectorType {

/// Starts the debug server on localhost:8080/inspect.
/// - Note: The debug server is only available in the simulator.
public func startDebugServer() {
public func startRenderInspectorServer() {
Inspector.shared.startServer()
}
2 changes: 1 addition & 1 deletion samples/Demo/AppDelegate.swift
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {

/// Starts the debug server on the simulator.
startDebugServer()
startRenderInspectorServer()

// Override point for customization after application launch.
window = UIWindow(frame: UIScreen.main.bounds)
Expand Down

0 comments on commit 0175a95

Please sign in to comment.