diff --git a/__PROJECT_NAME__/README.md b/__PROJECT_NAME__/README.md index 8770493..4933413 100644 --- a/__PROJECT_NAME__/README.md +++ b/__PROJECT_NAME__/README.md @@ -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__) @@ -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) -Screenshot +Screenshot ## Example @@ -69,4 +87,4 @@ __AUTHOR NAME__ ## License -__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info. \ No newline at end of file +__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info.