diff --git a/README.md b/README.md index 3210a95..5558cc6 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,7 @@ ## Introduction -This SDK enables real-time 3D scanning, asset storage, and analysis in your own iOS app using algorithms and servers from [Standard Cyborg](https://standardcyborg.com). - -The quickest way to get started is to clone this repository, then follow the [iOS Quickstart Guide](https://standardcyborg.com/docs/ios-quickstart) +This SDK enables real-time 3D scanning and analysis in your own iOS app! ![app-scanning-preview](https://user-images.githubusercontent.com/6288076/51778445-84766880-20b6-11e9-8f46-b63c0a016d8b.png) ![app-scan-preview](https://user-images.githubusercontent.com/6288076/51778444-84766880-20b6-11e9-9f6c-914071556d8e.png) @@ -12,9 +10,7 @@ The quickest way to get started is to clone this repository, then follow the [iO ## Repository Overview - **StandardCyborgFusion**
- A compiled, binary framework that performs real time 3D reconstruction using the TrueDepth camera -- **StandardCyborgNetworking**
- A Swift framework that connects to the platform.standardcyborg.com API + A compiled, binary framework that performs real time 3D reconstruction using the TrueDepth camera. Built from https://github.com/StandardCyborg/StandardCyborgSDK - **StandardCyborgUI**
A Swift framework with classes for driving and visualizing scanning using StandardCyborgFusion - **StandardCyborgExample**
@@ -23,13 +19,8 @@ The quickest way to get started is to clone this repository, then follow the [iO ## Run included demo app 1. `cd StandardCyborgExample` -2. Drop your API token into `Info.plist` (from your platform.standardcyborg.com account) -3. `pod install` -4. Run on a device with TrueDepth - -## Documentation - -All documentation is hosted at https://standardcyborg.com/docs/ios-quickstart/ +1. `pod install` +1. Run on an iOS device with a TrueDepth sensor ## Requirements @@ -39,12 +30,8 @@ All documentation is hosted at https://standardcyborg.com/docs/ios-quickstart/ ## Feedback, Issues, and Help -Email sdk@standardcyborg.com and we will gladly reply in a timely manner. - -You may also find an answer to your question in our [FAQ](https://standardcyborg.com/docs/faq) - ## License -The StandardCyborgFusion framework is provided as a compiled, closed-source framework with a proprietary license. -The remaining projects within this repository are open source with an Apache 2.0 license. -See the LICENSE file within each subdirectory in this project for specific details. +This codebase is released under the MIT license + +See LICENSE file