diff --git a/Pod/Classes/TouchVisualizerConfig.swift b/Pod/Classes/TouchVisualizerConfig.swift index b8d2caa..54d1b3d 100644 --- a/Pod/Classes/TouchVisualizerConfig.swift +++ b/Pod/Classes/TouchVisualizerConfig.swift @@ -9,9 +9,17 @@ import Foundation public struct TouchVisualizerConfig { + + /** + Color of touch points. + */ public var color: UIColor = { UIColor(red: 52/255.0, green: 152/255.0, blue: 219/255.0, alpha: 0.8) }() + + /** + Image of touch points. + */ public var image: UIImage = { let rect = CGRectMake(0, 0, 60.0, 60.0); UIGraphicsBeginImageContextWithOptions(rect.size, false, 0) @@ -23,9 +31,20 @@ public struct TouchVisualizerConfig { image.imageWithRenderingMode(.AlwaysTemplate) return image }() + + /** + Default touch point size. If `showsTouchRadius` is enabled, this value is ignored. + */ public var defaultSize = CGSize(width: CGFloat(60.0), height: CGFloat(60.0)) + + /** + Shows touch duration. + */ public var showsTimer = false - // Shows touch radius. It doesn't work on simulator because it is not possible to read touch radius on it. Please test it on device. + + /** + Shows touch radius. It doesn't work on simulator because it is not possible to read touch radius on it. Please test it on device. + */ public var showsTouchRadius = false public init() {} diff --git a/README.md b/README.md index 90dd942..f43650d 100644 --- a/README.md +++ b/README.md @@ -15,11 +15,11 @@ Effective presentation with TouchVisualizer! Main features are below. - Shows touch duration. - You can change colors and images of finger points. -![top](https://github.com/morizotter/TouchVisualizer/blob/master/top.png) +![top](https://raw.githubusercontent.com/morizotter/TouchVisualizer/master/top.png) Catch the image with GIF! -![gif](https://github.com/morizotter/TouchVisualizer/blob/master/presentation.gif) +![gif](https://raw.githubusercontent.com/morizotter/TouchVisualizer/master/presentation.gif) Let's give a presentation effectively @@ -80,7 +80,7 @@ TouchVisualizer.stop() ## Document -- [How to take an iOS screen movie](doc/take_a_movie.md) +- [How to take an iOS screen movie](misc/take_a_movie.md) ## Contribution diff --git a/doc/img/movie_recording.png b/misc/img/movie_recording.png similarity index 100% rename from doc/img/movie_recording.png rename to misc/img/movie_recording.png diff --git a/doc/img/select_input.png b/misc/img/select_input.png similarity index 100% rename from doc/img/select_input.png rename to misc/img/select_input.png diff --git a/doc/take_a_movie.md b/misc/take_a_movie.md similarity index 100% rename from doc/take_a_movie.md rename to misc/take_a_movie.md