Skip to content

Latest commit

 

History

History
73 lines (43 loc) · 2.54 KB

README.md

File metadata and controls

73 lines (43 loc) · 2.54 KB
Raw

ProgressKit

Swift SDK to visualize your progress based on Apple Reminders.

ProgressKit Preview

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See usage for notes on how to use the framework in your own app.

Prerequisites

Installing

Simply install the needed dependencies using Carthage to kick things off:

carthage bootstrap --platform iOS

That's it. Happy Hacking!

Use in your own app

Simply add ProgressKit as Carthage dependency to use it in your own app. To do so, add the following line to your Cartfile:

github "Progress4Apple/ProgressKit" ~> 1.0

Don't forget to also add the built libraries in Xcode! See "Adding frameworks to an application" in the Carthage documentation for further details:

  • ProgressKit.framework
  • FLAnimatedImage.framework
  • GiphyCoreSDK.framework

Documentation

For detailed instructions on how to use ProgressKit in your app, visit its SDK documentation at https://sdk.progress.rocks.

Built With

  • Giphy - The GIPHY Core SDK is a wrapper around the GIPHY API
  • FLAnimatedImage - Performant animated GIF engine for iOS
  • Jazzy

Contributing

Questions and Pull Requests are always welcome. Feel free to submit as you see fit!

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments