Skip to content

Commit 89aa114

Browse files
committed
add full instructions to README, fixes #5
1 parent 1b1f6d2 commit 89aa114

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

__PROJECT_NAME__/README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,21 @@
1+
# WARNING
2+
3+
Thank you for using swift3-module-template. Before you release your awesome project to the world, complete the following steps.
4+
5+
THIS LIST IS EASY, CHECK IT OFF ONE-BY-ONE BABY!
6+
7+
- [ ] Open the project in Xcode and add features to __PROJECT_NAME__
8+
- [ ] Make sure you are using Swift 3 ("Convert to latest Swift syntax")
9+
- [ ] Fix all build errors and warnings, add tests (yes really)
10+
- [ ] Add a screenshot or AT LEAST some picture, and fill in this readme
11+
- [ ] Add all details to your [Podspec](__PROJECT_NAME__.podspec)
12+
- [ ] Delete all this crap up here
13+
- [ ] Make one release (full steps are in [CONTRIBUTING.md] in case you forget)
14+
15+
THEN YOU'RE DONE, GO STAR [swift3-module-template](https://github.com/fulldecent/swift3-module-template) FOR UPDATES.
16+
17+
----
18+
119
# __PROJECT_NAME__
220

321
[![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 @@
624
[![Platform](https://img.shields.io/cocoapods/p/__PROJECT_NAME__.svg?style=flat)](https://cocoapods.org/pods/__PROJECT_NAME__)
725
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
826

9-
<a href="placehold.it/400?text=Screen+shot"><img width=200 height=200 src="placehold.it/400?text=Screen+shot" alt="Screenshot" /></a>
27+
<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>
1028

1129

1230
## Example
@@ -69,4 +87,4 @@ __AUTHOR NAME__
6987

7088
## License
7189

72-
__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info.
90+
__PROJECT_NAME__ is available under the MIT license. See the LICENSE file for more info.

0 commit comments

Comments
 (0)