Merge pull request #5 from srea/feature/update-readme

[ci skip] update Readme
srea · Dec 3, 2019 · 5d9b1e4 · 5d9b1e4
2 parents 90fa597 + 94e5894
commit 5d9b1e4
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -2,17 +2,26 @@
 [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
 # RIBsTreeViewer
 
+![](./docs/logo.png)  
+
 Real Time viewing attached RIBs Tree on Browser
 
-# Carthage
+## Demo
+
+![](./docs/demo.gif)  
+
+## Carthage
 
-## Cartfile
+### Cartfile
 
 ```shell
 github "srea/RIBsTreeViewerClient"
 ```
 
-## Build Phase
+### Build Phase
+
+![](./docs/Carthage_BuildPhase.png)  
+![](./docs/Carthage_Embedded.png)
 
 Carthage CopyFrameworks (ONLY DEBUG)
 
@@ -22,7 +31,7 @@ Carthage CopyFrameworks (ONLY DEBUG)
  fi
 ```
 
-## Implementation
+### Implementation
 
 ```swift
 #if DEBUG
@@ -61,17 +70,31 @@ extension AppDelegate {
 #endif
 ```
 
-# WebSocket Server
+## WebSocket Server
 
 ```shell
 $ yarn install
 $ node index.js
 ```
 
-# Browser
+## Browser
 
 ```shell
 $ yarn install
 $ npx webpack
 $ open ./public/index.html
 ```
+
+## Options
+
+### .webSocketURL
+
+```swift
+        #if DEBUG
+        if #available(iOS 13.0, *) {
+            ribsTreeViewer = RIBsTreeViewerImpl.init(router: launchRouter,
+                                                     option: [.webSocketURL: "ws://0.0.0.0:8080"])
+            ribsTreeViewer?.start()
+        }
+        #endif
+```
diff --git a/docs/Carthage_BuildPhase.png b/docs/Carthage_BuildPhase.png
diff --git a/docs/Carthage_Embedded.png b/docs/Carthage_Embedded.png
diff --git a/docs/demo.gif b/docs/demo.gif
diff --git a/docs/logo.png b/docs/logo.png