Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions ColorKit.podspec → ColorsKit.podspec
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Pod::Spec.new do |s|
s.name = 'ColorKit'
s.name = 'ColorsKit'
s.version = '0.1.0'
s.summary = 'Comprehensive color management for iOS: hex APIs, theming, accessibility, gradients.'
s.description = <<-DESC
Expand All @@ -13,10 +13,13 @@ ColorKit simplifies color usage in iOS apps by providing:
DESC
s.homepage = 'https://github.com/ckdash-git/ColorKit'
s.license = { :type => 'MIT', :file => 'LICENSE' }
s.author = { 'Your Name' => 'you@example.com' }
s.author = { 'Your Name' => 'Chandan Kumar Dash' }
s.source = { :git => 'https://github.com/ckdash-git/ColorKit.git', :tag => s.version.to_s }
s.platform = :ios, '13.0'
s.swift_version = '5.9'
s.ios.deployment_target = '13.0'
s.osx.deployment_target = '12.0'
s.source_files = 'Sources/**/*.{swift}'
s.requires_arc = true
s.module_name = 'ColorKit'
s.documentation_url = 'https://github.com/ckdash-git/ColorKit#readme'
end
21 changes: 19 additions & 2 deletions Documentation/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,25 @@ Use the GitHub URL and a tagged version in Xcode or `Package.swift`.

In Xcode: File → Add Packages… → paste the URL → select the `ColorKit` product.

### CocoaPods (Podspec template)
A `ColorKit.podspec` is included; publish with `pod trunk push` once configured.
### CocoaPods
Install via CocoaPods using the published pod `ColorsKit`:

```ruby
platform :ios, '13.0'
use_frameworks!

target 'App' do
pod 'ColorsKit', '~> 0.1'
end
```

Then run `pod install` and import the module in your code:

```swift
import ColorKit
```

Note: The CocoaPods pod name is `ColorsKit`, but the Swift module remains `ColorKit`.

## Usage

Expand Down
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ColorKit

[![version](https://img.shields.io/github/v/tag/ckdash-git/ColorKit?label=version)](https://github.com/ckdash-git/ColorKit/tags) [![lines of code](https://tokei.rs/b1/github/ckdash-git/ColorKit?category=code)](https://github.com/ckdash-git/ColorKit) [![license](https://img.shields.io/github/license/ckdash-git/ColorKit)](LICENSE)
[![version](https://img.shields.io/github/v/tag/ckdash-git/ColorKit?label=version)](https://github.com/ckdash-git/ColorKit/tags) [![lines of code](https://tokei.rs/b1/github/ckdash-git/ColorKit?category=code)](https://github.com/ckdash-git/ColorKit) [![license](https://img.shields.io/github/license/ckdash-git/ColorKit)](LICENSE) [![CocoaPods](https://img.shields.io/cocoapods/v/ColorsKit.svg)](https://cocoapods.org/pods/ColorsKit)

Pragmatic color utilities for SwiftUI and UIKit.

Expand Down Expand Up @@ -36,6 +36,26 @@ Add the package to Xcode or your `Package.swift` using the public repo and a tag

In Xcode: File → Add Packages… → paste the URL → add the `ColorKit` product.

## Installation (CocoaPods)
Add to your Podfile (iOS example):

```ruby
platform :ios, '13.0'
use_frameworks!

target 'App' do
pod 'ColorsKit', '~> 0.1'
end
```

Then run `pod install` and import the module:

```swift
import ColorKit
```

Note: The CocoaPods pod name is `ColorsKit`, but the Swift module is `ColorKit`.

## Quick Start
```swift
import ColorKit
Expand Down Expand Up @@ -95,6 +115,7 @@ A tiny command‑line demo lives in `Example/ConsumerSample/`.
## Platform Notes
- `Color.dynamic` bridges to `Color(uiColor:)` on iOS/tvOS.
- On iOS/tvOS < 15, `Color.dynamic` falls back to the light variant.
- CocoaPods support: iOS and macOS in `0.1.0`; tvOS/watchOS coming in a follow‑up release.

## Versioning
This repo follows semantic versioning. Start with `0.1.0` and evolve via tags.
Expand Down