Home Explore Help
Sign In
mirror
/
Kingfisher
mirror of https://github.com/onevcat/Kingfisher.git
2
0
Fork 0
Files Issues 0 Wiki

No Description

Tree: aef2e8674e
Branches Tags
Kingfisher
ZIP TAR.GZ
onevcat aef2e8674e Change the default indicator style for macOS 26 4 months ago
.claude a5720fd900 Add prechange command 7 months ago
.github 2622536b4a Optimize CI workflow to avoid duplicate runs 7 months ago
Demo c384d5d731 Merge pull request #2416 from onevcat/darkbrewx-feature/network-metrics 6 months ago
Kingfisher.xcodeproj c384d5d731 Merge pull request #2416 from onevcat/darkbrewx-feature/network-metrics 6 months ago
Kingfisher.xcworkspace 5a4b34c2db Move Pod dependency to project 6 years ago
Sources aef2e8674e Change the default indicator style for macOS 26 4 months ago
Tests 4907841340 Add network metrics collection for download tasks 6 months ago
docs 7453b2cbb7 Add LLM docs to the projects 8 months ago
fastlane ba4a7f32f8 Update default Xcode version 7 months ago
images 1869184c7b Protocol indicator 9 years ago
.gitignore 197fe75c30 Add gitignore entries for Claude local settings 8 months ago
.ruby-version dcdf4c64d1 Update Ruby and Xcode versions 1 year ago
.spi.yml f17aa80945 Only SPM can build doc correctly 1 year ago
CHANGELOG.md 2015fda791 Bump version to 8.5.0 7 months ago
CLAUDE.md e573674ab3 Update format 7 months ago
CONTRIBUTING.md 04a8d22dfd Fixes broken link in contributing documentation 4 years ago
Gemfile bc8558672d Remove doc generate lane 5 years ago
Gemfile.lock 83d7fbc17c Bump rexml from 3.4.1 to 3.4.2 4 months ago
Kingfisher.json 7707172289 Add Carthage support for both watchOS and iOS platform 7 months ago
Kingfisher.podspec 2015fda791 Bump version to 8.5.0 7 months ago
LICENSE 107bc366fe Update LICENSE 6 years ago
Package.swift 12918567e3 Update support version in Package.swift 2 years ago
Package@swift-5.9.swift 6c3f663f59 Merge branch 'master' into v8 1 year ago
README-LLM.md 7453b2cbb7 Add LLM docs to the projects 8 months ago
README.md 5387e7b3f1 Update doc 1 year ago

README-LLM.md

Kingfisher

Kingfisher is a powerful, pure-Swift library for downloading and caching images from the web, providing elegant async APIs for iOS, macOS, tvOS, watchOS, and visionOS applications. The library handles the complete image lifecycle with multi-layer caching, built-in processing, and extensive UI component integrations.

Quick Start

Core API Entry Points:

  • Sources/General/KingfisherManager.swift - Central coordinator
  • Sources/General/KF.swift - Builder pattern API (KF.url()...)
  • Sources/Extensions/ImageView+Kingfisher.swift - UIKit/AppKit extensions
  • Sources/SwiftUI/KFImage.swift - SwiftUI components

Essential Build Commands:

# Install dependencies and run all tests
bundle install && bundle exec fastlane tests

# Build for specific platform
swift build

# Full release workflow
bundle exec fastlane release version:X.X.X

Documentation

For LLMs and Developers:

  • Project Overview - What Kingfisher does, core purpose, technology stack, and platform support
  • Architecture - System organization, component map, key files, and data flow with specific file references
  • Build System - Swift Package Manager and Fastlane workflows, platform setup, and troubleshooting
  • Testing - Test categories, running tests, and test infrastructure with file locations
  • Development - Code style, implementation patterns, workflows, and common solutions
  • Deployment - Package types, platform deployment, release management, and CI/CD
  • File Catalog - Comprehensive file organization with specific file purposes and relationships

Configuration Files:

  • Package.swift - Swift Package Manager manifest
  • Kingfisher.podspec - CocoaPods specification
  • fastlane/Fastfile - Build automation
  • Sources/Documentation.docc/ - DocC documentation

Key Patterns:

  • Namespace wrapper (.kf property) in Sources/General/Kingfisher.swift
  • Builder pattern API in Sources/General/KF.swift
  • Options system in Sources/General/KingfisherOptionsInfo.swift
  • Protocol-oriented design throughout Sources/Image/ImageProcessor.swift

Requirements

  • Swift 5.9+ (Swift 6 strict concurrency ready)
  • iOS 13.0+ / macOS 10.15+ / tvOS 13.0+ / watchOS 6.0+ / visionOS 1.0+
  • SwiftUI support: iOS 14.0+ / macOS 11.0+ / tvOS 14.0+ / watchOS 7.0+ / visionOS 1.0+