endoumari / ios-readme-template

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

Product Name

Short blurb about what your product does.

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")
}

Release History

• 0.2.1
  • CHANGE: Update docs (module code remains unchanged)
• 0.2.0
  • CHANGE: Remove setDefaultXYZ()
  • ADD: Add init()
• 0.1.1
  • FIX: Crash when calling baz() (Thanks @GenerousContributorName!)
• 0.1.0
  • The first proper release
  • CHANGE: Rename foo() to bar()
• 0.0.1
  • Work in progress

Contribute

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

Meta

Your Name – @YourTwitter – [email protected]

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

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