BFKit Save

BFKit is a collection of useful classes and categories to develop Apps faster.

Project README

BFKit Banner

Build Status Carthage compatible Version Language Platform License


Swift VersionWhat does it doLanguage supportRequirementsCommunicationContributingInstalling and UsageDocumentationChangelogDemoTodoAuthorLicense


Swift Version

If you are looking for Swift version check it out here: BFKit Swift

What does it do

BFKit is a collection of useful classes to develop Apps faster. For example you can use every iOS font with just an enum! It also adds some useful method to some classes like:

BFKit:

Foundation:

UIKit:

Language support

  • Brazilian Portuguese (pt-Br)
  • English (en)
  • Indonesian (id)
  • Italian (it)
  • Russian (ru)
  • Simplified Chinese (zh-Hans)
  • Swedish (sv)
  • Traditional Chinese (zh-Hant)
  • Traditional Turkish (tr-TR)
  • Ukrainian (uk)
  • Vietnamese (vi)

Requirements

  • iOS SDK 7.0 if you copy the Framework files (Source folder)
  • iOS SDK 8.0 if you use it as a Framework
  • Xcode 7.0 or later
  • ARC

Communication

  • If you need help, use Stack Overflow.
  • If you found a bug, open an issue.
  • If you have a feature request, open an issue.
  • If you want to contribute, see Contributing section.

Contributing :octocat:

See CONTRIBUTING.md file.

Installing and Usage

iOS 7 or later compatible

Manual

  • Copy the Source folder to the project
  • Add the following frameworks to the project:
    • UIKit
    • Foundation
    • CoreImage
    • CoreGraphics
    • QuartzCore
    • Accelerate
    • AudioToolbox (if you want to use BFSystemSound class)
    • LocalAuthentication (if you want to use BFTouchID class, and set it as weak if your App runs on iOS 7)
  • Import BFKit with #import "BFKit.h"
  • Enjoy!

CocoaPods

Pro version
  • pod 'BFKit'
  • Import the Framework with import BFKit
  • Enjoy!
Newbie version
  • Create a Podfile in your project directory

  • Write:

    platform :ios, '7.0'
    xcodeproj 'Project.xcodeproj'
    
    pod 'BFKit'
    
  • Change "Project" with your real project name

  • Open Terminal, go to project directory and type: pod install

  • Import the Framework with #import <BFKit/BFKit.h>

  • Enjoy!

iOS 8 or later compatible

Manual

  • Open the BFKit folder and build the Framework from the project
  • Import BFKit.framework into your project
  • Add the following frameworks to the project:
    • UIKit
    • Foundation
    • CoreImage
    • CoreGraphics
    • QuartzCore
    • Accelerate
    • AudioToolbox (if you want to use BFSystemSound class)
    • LocalAuthentication (if you want to use BFTouchID class, and set it as weak if your App runs on iOS 7)
  • Import the Framework with import BFKit
  • Enjoy!

Carthage

Pro version
  • github "FabrizioBrancati/BFKit"
  • Import the Framework with import BFKit
  • Enjoy!
Newbie version
  • Create a Cartfile in your project directory

  • Write:

    github "FabrizioBrancati/BFKit"
    
  • Open Terminal, go to project directory and type: carthage update

  • Include the created Framework in your project

  • Add Build Phase with the following contents:

    /usr/local/bin/carthage copy-frameworks
    

    Add the paths to the Queuer framework under Input Files

    $(SRCROOT)/Carthage/Build/iOS/BFKit.framework
    

    Add the paths to the copied frameworks to the Output Files

    $(BUILT_PRODUCTS_DIR)/$(FRAMEWORKS_FOLDER_PATH)/BFKit.framework
    

    This script works around an App Store submission bug triggered by universal binaries and ensures that necessary bitcode-related files are copied when archiving

  • (Optional) Add Build Phase with the following contents

    /usr/local/bin/carthage outdated --xcode-warnings
    

    To automatically warn you when one of your dependencies is out of date

  • Import the Framework with import BFKit

  • Enjoy!

Documentation

CocoaDocs - 100% Documented

Changelog

To see what has changed in recent version of BFKit, see the CHANGELOG

Demo

Open and run the BFKitDemo project in Xcode and see BFKit in action!

Todo

  • :heavy_minus_sign: Create great tests and add Coveralls badge
  • :heavy_minus_sign: Add support to macOS, watchOS and tvOS
  • :heavy_minus_sign: Create a new Example App that shows all the functionalities of BFKit
  • :heavy_check_mark: Add Carthage support
  • :heavy_check_mark: Add to CocoaPods
  • :heavy_check_mark: Create a great documentation

Author

Fabrizio Brancati

Website
Email

License

BFKit is available under the MIT license. See the LICENSE file for more info.

Open Source Agenda is not affiliated with "BFKit" Project. README Source: FabrizioBrancati/BFKit
Stars
798
Open Issues
1
Last Commit
3 years ago
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating