improve README

This commit is contained in:
Yonat Sharon 2017-06-25 12:26:01 +03:00
parent e4dafa71e9
commit 9fd54a5cb3
1 changed files with 27 additions and 0 deletions

View File

@ -1,6 +1,13 @@
# BatteryView
Simple battery shaped UIView.
[![Swift Version][swift-image]][swift-url]
[![Build Status][travis-image]][travis-url]
[![License][license-image]][license-url]
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/BatteryView.svg)](https://img.shields.io/cocoapods/v/BatteryView.svg)
[![Platform](https://img.shields.io/cocoapods/p/BatteryView.svg?style=flat)](http://cocoapods.org/pods/BatteryView)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
<p align="center">
<img src="Screenshots/Battery.png">
</p>
@ -37,6 +44,11 @@ batteryView.cornerRadius = 5 // default is batteryLength / 10
```
## Requirements
- iOS 8.0+
- Xcode 7.3
## Installation
### CocoaPods:
@ -48,3 +60,18 @@ pod 'BatteryView'
### Manually:
Copy `Sources/*` to your Xcode project.
## Meta
[@yonatsharon](https://twitter.com/yonatsharon)
[https://github.com/yonat/BatteryView](https://github.com/yonat/BatteryView)
[swift-image]:https://img.shields.io/badge/swift-3.0-orange.svg
[swift-url]: https://swift.org/
[license-image]: https://img.shields.io/badge/License-MIT-blue.svg
[license-url]: LICENSE.txt
[travis-image]: https://img.shields.io/travis/dbader/node-datadog-metrics/master.svg?style=flat-square
[travis-url]: https://travis-ci.org/dbader/node-datadog-metrics
[codebeat-image]: https://codebeat.co/badges/c19b47ea-2f9d-45df-8458-b2d952fe9dad
[codebeat-url]: https://codebeat.co/projects/github-com-vsouza-awesomeios-com