Skip to content

Commit

Permalink
add README and gif file.
Browse files Browse the repository at this point in the history
  • Loading branch information
mittsu333 committed Apr 21, 2016
1 parent 2521aeb commit 0d82544
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 13 deletions.
64 changes: 51 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,67 @@
# MarkedView
## MarkedView Example
---


## Introduction
---

The MarkedView is the markdown text viewer.

select the best one from UIWebview or WKWebview.

* UIMarkedView
* UIWebView base


* WKMarkedView
* WKWebView base

[![CI Status](http://img.shields.io/travis/mittsu/MarkedView.svg?style=flat)](https://travis-ci.org/mittsu/MarkedView)
[![Version](https://img.shields.io/cocoapods/v/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView)
[![License](https://img.shields.io/cocoapods/l/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView)
[![Platform](https://img.shields.io/cocoapods/p/MarkedView.svg?style=flat)](http://cocoapods.org/pods/MarkedView)

## Usage
---

The same process except the initialization.

Call is available from any text from any file .

```
import MarkedView
To run the example project, clone the repo, and run `pod install` from the Example directory first.
・・・
// WKWebView base
let mdView = WKMarkedView()
// view set
self.view = mdView
// set Markdown text pattern
mdView.textToMark(contents)
// or load Markdown file pattern
// mdView.loadFile(filePath)
```

## Requirements

## Installation
---

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

```ruby
pod "MarkedView"
To install it, simply add the following line to your ``` Podfile ```:


```
pod 'MarkedView'
```

## Author
Then run the following command:

mittsu, [email protected]
```
$ pod install
```

## License
---

MarkedView is available under the MIT license. See the LICENSE file for more info.
Binary file added markedview.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0d82544

Please sign in to comment.