ClockWise
ClockWise is a lightweight Swift utilities
Simplified iOS Utilities
This is a collection of utilities I used in many projects, the Simplified suite of products and code bases for iOS.
Objectives
Generality: the classes and functions should be general-purpose enough to be used independently of the product they are used in. Absolutely no third party dependencies: we want to be able to use this module anywhere without any additional requirements. Testability: every utility should be easily unit-testable.
Table of Contents
- Getting Started
- How it works "Usage"
- Exmple
- Supported OS & SDK Versions
- Versioning
- TODO
- Contributing
- CHANGELOG
- Related Projects
- Author
- License
Getting Started "Installation"
CocoaPods
ClockWise is available through CocoaPods. To install it, simply add the following line to your Podfile:
pod 'ClockWise'
https://cocoapods.org/pods/ClockWise
Swift Package Manager (SPM)
The Swift Package Manager is a tool for automating the distribution of Swift code and is integrated into the swift compiler. To integrate using Apple's Swift package manager from xcode :
File -> Swift Packages -> Add Package Dependency...
enter package URL : https://github.com/amrangry/ClockWise.git , choose the latest release
Manually
To install manually the ClockWise classes in your app, just drag the Source class files (demo files and assets are not needed) into your project.
Add content of folder Source/* to your project
How it works "Usage"
- Import
ClockWise
module to yourSwift
class
import ClockWise
- Enjoy
Example
To run the example project, clone the repo, and run pod install
from the Example directory first.
Supported OS & SDK Versions
- Supported build target - iOS 10.0 and later (Xcode 11.x)
Versioning
this project adheres to Semantic versioning
Given a version number MAJOR.MINOR.PATCH, increment the:
- MAJOR version when you make incompatible API changes,
- MINOR version when you add functionality in a backwards compatible manner, and
- PATCH version when you make backwards compatible bug fixes.
TODO
- Segregate UIKit & Foundation
- CI/CD
- More test test test ... (and example)
Contributing
We alway welcome your contributions
Development
- Fork (https://github.com/amrangry/ClockWise)
🎉 - Create a feature branch
☕ - Run test suite with the
$ make test
command and confirm that it passes⚡ - Commit your changes
📝 - Rebase your local changes against the
master
branch💡 - Create new Pull Request
💌
Bugs, feature requests and comments are more than welcome in the issues.
Feedback
I would like to make ClockWise
a better tool.
The goal is to be able to use in various projects.
Therefore, your feedback is very useful.
I am very happy to tell you your opinions on Issues and PR
CHANGELOG
See CHANGELOG.md
Let us know! Apps using ClockWise
We’d be really happy if you sent us links to your projects where you use our component. Just send an email to [email protected] And do let us know if you have any questions or suggestion regards.
Author
AmrAngry, [email protected]
License
ClockWise is available under the MIT license. See the LICENSE file for more info.