Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
honkmaster committed Jul 31, 2020
1 parent 5d54ef1 commit d95c30b
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
# TTProgressHUD

`TTProgressHUD` is a light weight HUD written in SwiftUI meant to display the progress of an ongoing task on iOS.
`TTProgressHUD` is a light weight HUD written in SwiftUI meant to display the progress of an ongoing task on iOS. `TTProgressHUD` (left) was designed to look as similar as possible to the Apple HUD (example from Podcast.app, right).

<img src="https://raw.githubusercontent.com/honkmaster/TTProgressHUD/master/Sample.jpg" width="500">

`TTProgressHUD` (left) was designed to look as similar as possible to the Apple HUD (example from Podcast.app, right).

## Installation

Xcode 11 and iOS 13 is required.
Expand All @@ -28,7 +26,7 @@ Drag `TTProgressHUD.swift` and `TTProgressHUDConfig.swift` into your project.
Import the `TTProgressHUD` package:

```swift
import TTGaugeView
import TTProgressHUD
```

### Instantiate and show the HUD view
Expand Down Expand Up @@ -84,7 +82,7 @@ public init(type:TTProgressHUDType = .Loading,

## Contributing to this project

If you have feature requests or bug reports, feel free to help out by sending pull requests or by [creating new issues](https://github.com/honkmaster/TTGaugeView/issues/new). Please take a moment to
If you have feature requests or bug reports, feel free to help out by sending pull requests or by [creating new issues](https://github.com/honkmaster/TTProgressHUD/issues/new). Please take a moment to
review the guidelines written by [Nicolas Gallagher](https://github.com/necolas):

* [Bug reports](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md#bugs)
Expand All @@ -93,8 +91,8 @@ review the guidelines written by [Nicolas Gallagher](https://github.com/necolas)

## License

`TTGaugeView` is distributed under the terms and conditions of the [MIT license](hhttps://github.com/honkmaster/TTGaugeView/blob/master/LICENSE).
`TTProgressHUD` is distributed under the terms and conditions of the [MIT license](hhttps://github.com/honkmaster/TTGaugeView/blob/master/LICENSE).

## Credits

`TTProgressHUD` is brought to you by [Tobias Tiemerding](http://tiemerding.com) and based on [SVProgressHUD](https://github.com/SVProgressHUD/SVProgressHUD). If you're using `TTGaugeView` in your project, attribution would be very appreciated.
`TTProgressHUD` is brought to you by [Tobias Tiemerding](http://tiemerding.com) and based on [SVProgressHUD](https://github.com/SVProgressHUD/SVProgressHUD). If you're using `TTProgressHUD` in your project, attribution would be very appreciated.

0 comments on commit d95c30b

Please sign in to comment.