-
Notifications
You must be signed in to change notification settings - Fork 3
README Template
This is a template. Everything that's quoted (like this text) are instructions, that shall not be included in the original.
Copy and paste everything from below. Make sure you do it in raw mode to preserve the links.
A brief description of the library in a few words.
An image or GIF showing your library in action.
##Overview
Describe what the library does, in a few sentences.
##Example
A useful example showing the usage of the library, in steps.
##Sample Project There's a sample project inside this repo that you can check out in order to have a deeper understanding of the usage of this library.
##Setup
- This library is available via cocoapods.
- Add this line to your
Podfile
:pod 'XXXXX' ~> '1.0'
- Add this line to your
- Otherwise, you can just drag and drop the
XXXXX
folder into your project, and keep it up to date by yourself.
##Contact Us For questions or general comments regarding the use of this library, please use our public hipchat room.
If you find any bug, a problem while using this library, or have suggestions that can make it better, please open an issue in this repo (or a pull request).
You can also check all of our open-source projects at inaka.github.io.
Make sure you change the link that says "open an issue" to point to the current repository.