ggndpsingh / iOS-readme-template

README.md template for your iOS open-source projects. Inspired by @dbader's readme-template

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Product Name

Short blurb about what your product does.

Swift Version Build Status License Carthage compatible CocoaPods Compatible
Platform PRs Welcome

One to two paragraph statement about your product and what it does.

Features

  • Feature 1
  • Feature 2
  • Feature 3
  • Feature 4
  • Feature 5

Requirements

  • iOS 8.0+
  • Xcode 7.3

Installation

CocoaPods

You can use CocoaPods to install YourLibrary by adding it to your Podfile:

platform :ios, '8.0'
use_frameworks!
pod 'YourLibrary'

To get the full benefits import YourLibrary wherever you import UIKit

import UIKit
import YourLibrary

Carthage

Create a Cartfile that lists the framework and run carthage update. Follow the instructions to add $(SRCROOT)/Carthage/Build/iOS/YourLibrary.framework to an iOS project.

github "yourUsername/yourlibrary"

Manually

  1. Download and drop YourLibrary.swift in your project.
  2. Congratulations!

Usage example

import EZSwiftExtensions
ez.detectScreenShot { () -> () in
    print("User took a screen shot")
}

Contribute

We would love you for the contribution to YourLibraryName, check the LICENSE file for more info.

Meta

Your Name – @YourTwitterYourEmail@example.com

Distributed under the XYZ license. See LICENSE for more information.

https://github.com/yourname/github-link

About

README.md template for your iOS open-source projects. Inspired by @dbader's readme-template

License:Other