diff --git a/CMToolkit.podspec b/CMToolkit.podspec new file mode 100644 index 0000000..9cea3da --- /dev/null +++ b/CMToolkit.podspec @@ -0,0 +1,38 @@ +# +# Be sure to run `pod lib lint CMToolkit.podspec' to ensure this is a +# valid spec before submitting. +# +# Any lines starting with a # are optional, but their use is encouraged +# To learn more about a Podspec see https://guides.cocoapods.org/syntax/podspec.html +# + +Pod::Spec.new do |s| + s.name = 'CMToolkit' + s.version = '1.0.0' + s.summary = 'A collection of tools, utilities, and helpers augmenting the Swift standard library.' + +# This description is used to generate tags and improve search results. +# * Think: What does it do? Why did you write it? What is the focus? +# * Try to keep it short, snappy and to the point. +# * Write the description between the DESC delimiters below. +# * Finally, don't worry about the indent, CocoaPods strips it! + + s.description = 'This framework acts as an augmentation of the swift standard library, adding common shorthands and convenience utilities to make life just that much better. Because you deserve nice things.' + s.homepage = 'https://github.com/schrismartin/CMToolkit' + s.license = { :type => 'MIT', :file => 'LICENSE' } + s.author = { 'Chris Martin' => 'schrismartin@me.com' } + s.source = { :git => 'https://github.com/schrismartin/CMToolkit.git', :tag => s.version.to_s } + s.social_media_url = 'https://twitter.com/schrismartin' + s.swift_version = '4.2' + s.ios.deployment_target = '9.0' + + s.source_files = 'Sources/**/*' + + # s.resource_bundles = { + # 'CMToolkit' => ['CMToolkit/Assets/*.png'] + # } + + # s.public_header_files = 'Pod/Classes/**/*.h' + # s.frameworks = 'UIKit', 'MapKit' + # s.dependency 'AFNetworking', '~> 2.3' +end diff --git a/README.md b/README.md index bc21e65..1fa6f9d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,37 @@ -# CMToolKit +# CMToolkit -[![Build Status](https://travis-ci.com/schrismartin/CMToolKit.svg?branch=master)](https://travis-ci.com/schrismartin/CMToolKit) [![Maintainability](https://api.codeclimate.com/v1/badges/7092afb1309114bf4f81/maintainability)](https://codeclimate.com/github/schrismartin/CMToolKit/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/7092afb1309114bf4f81/test_coverage)](https://codeclimate.com/github/schrismartin/CMToolKit/test_coverage) - -A collection of tools, utilities, and helpers used in Swift projects. +[![Build Status](https://travis-ci.com/schrismartin/CMToolKit.svg?branch=master)](https://travis-ci.com/schrismartin/CMToolkit) +[![Version](https://img.shields.io/cocoapods/v/CMToolkit.svg?style=flat)](https://cocoapods.org/pods/CMToolkit) +[![License](https://img.shields.io/cocoapods/l/CMToolkit.svg?style=flat)](https://cocoapods.org/pods/CMToolkit) +[![Platform](https://img.shields.io/cocoapods/p/CMToolkit.svg?style=flat)](https://cocoapods.org/pods/CMToolkit) +[![Maintainability](https://api.codeclimate.com/v1/badges/7092afb1309114bf4f81/maintainability)](https://codeclimate.com/github/schrismartin/CMToolKit/maintainability) +[![Test Coverage](https://api.codeclimate.com/v1/badges/7092afb1309114bf4f81/test_coverage)](https://codeclimate.com/github/schrismartin/CMToolKit/test_coverage) ## Installation -> Installation instructions will be here +### CocoaPods +CMToolkit is available through [CocoaPods](https://cocoapods.org). To install +it, add the following line to your Podfile: + +```ruby +pod 'CMToolkit' +``` + +### Swift Package Manager +CMToolkit is also available through [Swift Package Manager](https://swift.org/package-manager/). To install +it, add the following line to your `Package.swift`: + +```swift +dependencies: [ + .package(url: "https://github.com/schrismartin/CMToolkit.git", from: "1.0.0") +] +``` + +## Author + +Chris Martin, schrismartin@me.com + +## License + +CMToolkit is available under the MIT license. See the LICENSE file for more info. -## Contents -- Configurable - - `Transformable` - - `Settable` -- Optionals - - `try unwrapped()` - - `try unwrapped(as:)` \ No newline at end of file