Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
daisuke0131 committed Oct 21, 2020
1 parent c9c2bbf commit 7bc2c2d
Showing 1 changed file with 28 additions and 39 deletions.
67 changes: 28 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,110 +1,99 @@
![ViewMonitor](assets/viewmonitor.png)

[![Version](https://img.shields.io/cocoapods/v/ViewMonitor.svg?style=flat)](http://cocoapods.org/pods/ViewMonitor)
[![License](https://img.shields.io/cocoapods/l/ViewMonitor.svg?style=flat)](http://cocoapods.org/pods/ViewMonitor)
![Carthage](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)

## What's ViewMonitor

ViewMonitor can measure view positions with accuracy.
This library is to check design sheet from native app.

behave like this.

- UIViewController

![demo](assets/demo.gif)

![demo](assets/demo.gif)
- UITableViewController

![demo](assets/table_demo.gif)
![demo](assets/table_demo.gif)

## Usage

To run the example project, clone the repo.

## Requirements

- iOS 8.0+
- Xcode 7.0+

## Installation

### cocoaPods

ViewMonitor is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line in your Podfile:

```ruby
pod "ViewMonitor"
```

This library use swift.
So, you have to add `use_frameworks!` in Podfile.
after that, please run

after that, please run
```ruby
pod install
```

### Carthage
To install, you can also use [Carthage](https://github.com/Carthage/Carthage).

To install, you can also use [Carthage](https://github.com/Carthage/Carthage).
You can install Carthage with [Homebrew](http://brew.sh/).

```
$ brew update
$ brew install carthage
```

To integrate ViewMonitor into your Xcode project using Carthage, write the following line in your Cartfile.

```
github "daisuke0131/ViewMonitor"
```

### Manually

If you don't use CocoaPods and Carthage, you should add `Source/*` files in your project.

## How to use
#### For Swift Project

First, ```import ViewMonitor```
#### For Swift Project

Execute ```ViewMonitor.start()``` after application started.
First, `import ViewMonitor`
Execute `ViewMonitor.start()` after application started.
Like this

```
import ViewMonitor
func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
func applicationDidFinishLaunching(_ application: UIApplication) {
ViewMonitor.start()
return true
}
```
After that, execution button appear.

Please, refer to Example/ViewMonitorExample

#### For Objective-C Project
Add bridge-header in your project.
Add ```#import "YourProjectName-Swift.h"``` in your project.

Import ViewMonitor,
```@import ViewMonitor```

Execute ```[ViewMonitor start]``` after application started.
Like this
```
# import "YourProjectName-Swift.h"
@import ViewMonitor;

- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
// Override point for customization after application launch.
[ViewMonitor start];
return YES;
}
```
After that, execution button appear.

Please, refer to Example/ViewMonitorObjcExample
Please, refer to Example/ViewMonitorExample

## Author

### developer

[Daisuke Yamashita](https://github.com/daisuke0131)

### designer

[Satomi Nogawa](https://github.com/stmngw)

## License

ViewMonitor is available under the MIT license. See the LICENSE file for more info.

## Other

[How to measure UIView position on Native App](http://www.slideshare.net/daisukeyamashita180/18potatotips-yamashita) at potatotips #18

0 comments on commit 7bc2c2d

Please sign in to comment.