Skip to content

Commit

Permalink
add full instructions to README, fixes #5
Browse files Browse the repository at this point in the history
  • Loading branch information
fulldecent committed Sep 16, 2016
1 parent 1b1f6d2 commit 89aa114
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions __PROJECT_NAME__/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# WARNING

Thank you for using swift3-module-template. Before you release your awesome project to the world, complete the following steps.

THIS LIST IS EASY, CHECK IT OFF ONE-BY-ONE BABY!

- [ ] Open the project in Xcode and add features to __PROJECT_NAME__
- [ ] Make sure you are using Swift 3 ("Convert to latest Swift syntax")
- [ ] Fix all build errors and warnings, add tests (yes really)
- [ ] Add a screenshot or AT LEAST some picture, and fill in this readme
- [ ] Add all details to your [Podspec](__PROJECT_NAME__.podspec)
- [ ] Delete all this crap up here
- [ ] Make one release (full steps are in [CONTRIBUTING.md] in case you forget)

THEN YOU'RE DONE, GO STAR [swift3-module-template](https://github.com/fulldecent/swift3-module-template) FOR UPDATES.

----

# __PROJECT_NAME__

[![CI Status](http://img.shields.io/travis/__GITHUB_USERNAME__/__PROJECT_NAME__.svg?style=flat)](https://travis-ci.org/__GITHUB_USERNAME__/__PROJECT_NAME__)
Expand All @@ -6,7 +24,7 @@
[![Platform](https://img.shields.io/cocoapods/p/__PROJECT_NAME__.svg?style=flat)](https://cocoapods.org/pods/__PROJECT_NAME__)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

<a href="placehold.it/400?text=Screen+shot"><img width=200 height=200 src="placehold.it/400?text=Screen+shot" alt="Screenshot" /></a>
<a href="https://placehold.it/400?text=Screen+shot"><img width=200 height=200 src="https://placehold.it/400?text=Screen+shot" alt="Screenshot" /></a>


## Example
Expand Down Expand Up @@ -69,4 +87,4 @@ __AUTHOR NAME__

## License

__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info.
__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info.

0 comments on commit 89aa114

Please sign in to comment.