README iOS Template

ReadmeTemplate.md

Project Name

![](https://github.com/linkToYourImage.png)
![](https://github.com/linkToYourGif.gif)

Description

Overview of the project, uses of the project, etc

Requirements

• ARC / Non-ARC
• Minimum iOS Version+
• xCode Version Requirement
• External Library Dependencies
  • Library 1
  • Library 2
• Framework Dependencies
  • Framework 1
  • Framework 2

Installation

1. Installation process, Cocoapods and non-Cocoapods options preferred

2. Example installation step 1

   Example code section 1
   

3. Example installation step 2

   Example code section 2
   

Usage

Example usage 1

Example code section 1

Example usage 2

Example code section 2

Contributors

• username1
• username2

License

Project Name is available under the License Name license. See the LICENSE file for more info.

ReadmeTemplate.txt

# Project Name

`![](https://github.com/linkToYourImage.png)` </br>
`![](https://github.com/linkToYourGif.gif)` </br>

## Description

`Overview of the project, uses of the project, etc`

## Requirements

- `ARC / Non-ARC`
- `Minimum iOS Version`+
- `xCode Version Requirement`
- External Library Dependencies
	- `Library 1`
	- `Library 2`
- Framework Dependencies
	- `Framework 1`
	- `Framework 2`

## Installation

1. `Installation process, Cocoapods and non-Cocoapods options preferred`
2. `Example installation step 1`

    ```
    Example code section 1
    ```
3. `Example installation step 2`

    ```
    Example code section 2
    ```

## Usage

`Example usage 1`

    Example code section 1
    
`Example usage 2`

    Example code section 2

## Contributors

- [`username1`](http://github.com/username1)
- [`username2`](http://github.com/username2)

## License

`Project Name` is available under the `License Name` license. See the LICENSE file for more info.