Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add README #9

Closed
jsbean opened this issue Dec 25, 2016 · 1 comment
Closed

Add README #9

jsbean opened this issue Dec 25, 2016 · 1 comment
Assignees

Comments

@jsbean
Copy link
Member

jsbean commented Dec 25, 2016

No description provided.

@jsbean jsbean self-assigned this Dec 25, 2016
@jsbean jsbean mentioned this issue Dec 25, 2016
7 tasks
@jsbean
Copy link
Member Author

jsbean commented Dec 25, 2016

Use this as template:

> README.md

framework="# $1"

cat <<EOT>> README.md
$framework
![Swift](https://img.shields.io/badge/%20in-swift%203.0-orange.svg) [![Build Status](https://travis-ci.org/dn-m/$1.svg?branch=master)](https://travis-ci.org/dn-m/$1) [![codecov](https://codecov.io/gh/dn-m/$1/branch/master/graph/badge.svg)](https://codecov.io/gh/dn-m/$1/) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![GitHub version](https://badge.fury.io/gh/dn-m%2F$1.svg)](https://badge.fury.io/gh/dn-m%2F$1)
<a name="integration"></a>
## Integration
### Carthage
Integrate **$1** into your OSX or iOS project with [Carthage](https://github.com/Carthage/Carthage).
1. Follow [these instructions](https://github.com/Carthage/Carthage#installing-carthage) to install Carthage, if necessary.
2. Add \`github "dn-m/$1"\` to your [Cartfile](https://github.com/Carthage/Carthage/blob/master/Documentation/Artifacts.md#cartfile).
3. Follow [these instructions](https://github.com/Carthage/Carthage#adding-frameworks-to-an-application) to integrate **$1** into your OSX or iOS project.
***
### Documentation
See the [documentation](http://dn-m.github.io/$1/).
EOT

@jsbean jsbean closed this as completed Dec 25, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant