PieceOfKit

Swift Version codebeat badge CocoaPods CocoaPods

A collection of useful extensions and helper methods for iOS Swift 3 developers.

Build Information

master development
Build Status Build Status
codecov codecov

What is it?

PieceOfKit is a Cocoa Touch framework written in Swift 3 for iOS 9 and over. It contains useful extensions to basic types and some helpers methods. Initially inspired by projects like EZSwiftExtensions and ExSwift, I added things I use often under one roof. You can find a list of what it does at nicoschuele.github.io/PieceOfKit/.

Design Goals

  • Have a one stop shop for code reuse between different apps
  • Be fully documented

Installation

Manually

  1. git clone https://github.com/nicoschuele/PieceOfKit.git
  2. Add the PieceOfKit framework manually to your project. Don’t know how to do it? Ray Wenderlich has a step by step guide here.
  3. import PieceOfKit within your source files.

CocoaPods

  1. Have CocoaPods installed on your machine.
  2. Add PieceOfKit to your Podfile:

    platform :ios, '9.0'
    use_frameworks!
    
    target 'YourAppName' do
      pod 'PieceOfKit', '~> 1.0'
    end
    
  3. pod install

  4. import PieceOfKit within your source files.

Documentation & Usage

PieceOfKit is fully documented at nicoschuele.github.io/PieceOfKit/.

Contribute

Are there pieces of code you constantly reuse between apps? Extensions you copy-paste from one project to another? Well, you may consider adding them to PieceOfKit so people can profit from them as well.

  • Fork the code.
  • Implement your new feature.
  • Document it! This is not optional. Check some methods already in PieceOfKit to see how it’s done.
  • As much as possible, write unit tests. Add them to PieceOfKitTests.
  • Submit a pull request. One and only one per feature. Don’t group them, thanks!

Acknowledgements and Thanks

License

Copyright 2016 - Nico Schuele

Licensed under the Apache License, Version 2.0 (the License); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.