Skip to content
This repository has been archived by the owner on May 23, 2022. It is now read-only.

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
morizotter committed Dec 9, 2020
1 parent 9482e2d commit 139faa8
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 15 deletions.
1 change: 1 addition & 0 deletions Example/Example.xcodeproj/project.pbxproj
Expand Up @@ -209,6 +209,7 @@
developmentRegion = English;
hasScannedForEncodings = 0;
knownRegions = (
English,
en,
Base,
);
Expand Down
42 changes: 29 additions & 13 deletions README.md
Expand Up @@ -7,6 +7,7 @@
TouchVisualizer is a lightweight pure Swift implementation for visualising touches on the screen.

## Features

- Works with just **a single line of code**!
- Supports multiple fingers.
- Supports multiple `UIWindow`'s.
Expand All @@ -16,13 +17,21 @@ TouchVisualizer is a lightweight pure Swift implementation for visualising touch
- Supports iPhone and iPad in both portrait and landscape mode.

## How it looks

### Portrait:

![one](misc/one.gif)

### Landscape:

![two](misc/two.gif)

### Robots:

![three](misc/three.gif)

### In-app implementation:

![four](misc/four.gif)

It's fun!
Expand All @@ -33,9 +42,10 @@ It's fun!
- Xcode 9.2
- iOS9.0 or later

TouchVisualizer works with Swift 3 from version 3.0.0.
TouchVisualizer works with Swift 5.2 from version 4.0.0.

## Installation and Setup

**Note:** Embedded frameworks require a minimum deployment target of iOS 9.0.

**Information:** To use TouchVisualizer with a project targeting iOS 8.0 or lower, you must include the `TouchVisualizer.swift` source file directly in your project.
Expand All @@ -53,12 +63,13 @@ $ pods --version
To integrate TouchVisualizer into your Xcode project using CocoaPods, specify it in your `Podfile` and run `pod install`.

```bash
platform :ios, '8.0'
platform :ios, '9.0'
use_frameworks!
pod "TouchVisualizer", '~> 3.0'
pod "TouchVisualizer", '~> 4.0'
```

### Installing with Carthage

Carthage is a decentralised dependency manager that automates the process of adding frameworks to your Cocoa application.

You can install Carthage with [Homebrew](http://brew.sh/) using the following command:
Expand All @@ -71,7 +82,7 @@ $ brew install carthage
To integrate TouchVisualizer into your Xcode project using Carthage, specify it in your `Cartfile`:

```ogdl
github "morizotter/TouchVisualizer" "3.0.0"
github "morizotter/TouchVisualizer" "4.0.0"
```

### Manual Installation
Expand All @@ -97,6 +108,7 @@ and stop the presentation like this:
```swift
Visualizer.stop()
```

Get touch locations by this:

```swift
Expand All @@ -121,16 +133,17 @@ Visualizer.start(config)

### Configuration properties

|name|type|description|default|
|:----|:----|:----|:----|
| color | `UIColor` | Color of touch point and text. | default color |
| image | `UIImage` | Touch point image. If rendering mode is set to `UIImageRenderingModeAlwaysTemplate`, the image is filled with color above. | circle image |
| defaultSize| `CGSize` | Default size of touch point.| 60 x 60px |
| showsTimer| `Bool` | Shows touch duration. | false |
| showsTouchRadius | `Bool` | Shows touch radius by scaling touch point. It doesn't work on simulator. | false |
| showsLog | `Bool` | Shows log. | false |
| name | type | description | default |
| :--------------- | :-------- | :------------------------------------------------------------------------------------------------------------------------- | :------------ |
| color | `UIColor` | Color of touch point and text. | default color |
| image | `UIImage` | Touch point image. If rendering mode is set to `UIImageRenderingModeAlwaysTemplate`, the image is filled with color above. | circle image |
| defaultSize | `CGSize` | Default size of touch point. | 60 x 60px |
| showsTimer | `Bool` | Shows touch duration. | false |
| showsTouchRadius | `Bool` | Shows touch radius by scaling touch point. It doesn't work on simulator. | false |
| showsLog | `Bool` | Shows log. | false |

## Documentation

### Peripheral

- [How to take an iOS screen movie](misc/take_a_movie.md)
Expand All @@ -144,6 +157,9 @@ Visualizer.start(config)
Please file issues or submit pull requests for anything you’d like to see! We're waiting! :)

## Licensing

TouchVisualizer is released under the MIT license. Go read the LICENSE file for more information.

#### Miscellaneous
There is a similar *touch visualization* library called [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer), which is written in Objective-C. [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer) supports earlier versions of iOS and is more mature. If TouchVisualizer isn't enough for you, try that!

There is a similar _touch visualization_ library called [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer), which is written in Objective-C. [COSTouchVisualizer](https://github.com/conopsys/COSTouchVisualizer) supports earlier versions of iOS and is more mature. If TouchVisualizer isn't enough for you, try that!
4 changes: 2 additions & 2 deletions TouchVisualizer.podspec
Expand Up @@ -9,7 +9,7 @@

Pod::Spec.new do |s|
s.name = "TouchVisualizer"
s.version = "3.0.2"
s.version = "4.0.0"
s.summary = "Effective presentation with TouchVisualizer!"
s.description = <<-DESC
TouchVisualizer is a lightweight and pure Swift implemented library for visualizing touches on the screen. Let's give an effective presentation with TouchVisualizer!
Expand All @@ -30,7 +30,7 @@ Pod::Spec.new do |s|

s.platform = :ios, '9.0'
s.requires_arc = true
s.swift_version = '4.2'
s.swift_version = '5.2'

s.source_files = 'TouchVisualizer/**/*.swift'
end

0 comments on commit 139faa8

Please sign in to comment.