Added Android code
[wl-app.git] / iOS / Pods / JSQWebViewController / README.md
1
2 [![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)
3
4 > **NOTE:** As of iOS 9, this library is no longer necessary.
5 >
6 > You should use [`SFSafariViewController`](https://developer.apple.com/library/prerelease/ios/documentation/SafariServices/Reference/SFSafariViewController_Ref/index.html) instead.
7
8 # ⚠ Deprecated ⚠
9
10 # JSQWebViewController
11
12 [![Build Status](https://secure.travis-ci.org/jessesquires/JSQWebViewController.svg)](http://travis-ci.org/jessesquires/JSQWebViewController) [![Version Status](https://img.shields.io/cocoapods/v/JSQWebViewController.svg)][podLink] [![license MIT](https://img.shields.io/cocoapods/l/JSQWebViewController.svg)][mitLink] [![codecov](https://codecov.io/gh/jessesquires/JSQWebViewController/branch/develop/graph/badge.svg)](https://codecov.io/gh/jessesquires/JSQWebViewController) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![Platform](https://img.shields.io/cocoapods/p/JSQWebViewController.svg)][docsLink]
13
14 *A lightweight Swift WebKit view controller for iOS*
15
16 ![screenshot](https://raw.githubusercontent.com/jessesquires/JSQWebViewController/develop/Screenshots/screenshot_0.png)
17       
18 ![screenshot](https://raw.githubusercontent.com/jessesquires/JSQWebViewController/develop/Screenshots/screenshot_1.png)
19
20 ## Requirements
21
22 * Swift 3.2+
23 * Xcode 9+
24 * iOS 8+
25
26 ## Installation
27
28 #### [CocoaPods](http://cocoapods.org) (recommended)
29
30 ````ruby
31 use_frameworks!
32
33 # For latest release in cocoapods
34 pod 'JSQWebViewController'
35 ````
36
37 #### [Carthage](https://github.com/Carthage/Carthage)
38
39 ````bash
40 github "jessesquires/JSQWebViewController"
41 ````
42
43 ## Documentation
44
45 Read the [docs][docsLink]. Generated with [jazzy](https://github.com/realm/jazzy). Hosted by [GitHub Pages](https://pages.github.com).
46
47 #### Generate
48
49 ````bash
50 $ ./build_docs.sh
51 ````
52
53 #### Preview
54
55 ````bash
56 $ open index.html -a Safari
57 ````
58
59 ## Getting Started
60
61 ````swift
62 import JSQWebViewController
63
64 let controller = WebViewController(url: URL(string: "http://jessesquires.com")!)
65 let nav = UINavigationController(rootViewController: controller)
66 present(nav, animated: true, completion: nil)
67 ````
68
69 See the included example app, open `Example/Example.xcodeproj`.
70
71 ## Contribute
72
73 Please follow these sweet [contribution guidelines](https://github.com/jessesquires/HowToContribute).
74
75 ## Credits
76
77 Created and maintained by [**@jesse_squires**](https://twitter.com/jesse_squires).
78
79 ## License
80
81 `JSQWebViewController` is released under an [MIT License][mitLink]. See `LICENSE` for details.
82
83 >**Copyright © 2015 Jesse Squires.**
84
85 *Please provide attribution, it is greatly appreciated.*
86
87 [mitLink]:http://opensource.org/licenses/MIT
88 [docsLink]:http://jessesquires.github.io/JSQWebViewController
89 [podLink]:https://cocoapods.org/pods/JSQWebViewController