Aucune description

Frank 7707172289 Add Carthage support for both watchOS and iOS platform il y a 7 mois
.github 5de2a90cc6 Add CI build Xcode version il y a 1 an
Demo 71796c9272 Add SwiftUI demo scene for progressive JPEG il y a 11 mois
Kingfisher.xcodeproj 7deda23bbd Bump version to 8.3.2 il y a 10 mois
Kingfisher.xcworkspace 5a4b34c2db Move Pod dependency to project il y a 6 ans
Sources ebdfe95c0c Merge pull request #2398 from onevcat/fix/swift-continuation-misuse il y a 7 mois
Tests 80b808e789 Update Swift Task Continuation Misuse fix for Swift 6 compatibility il y a 7 mois
docs 7453b2cbb7 Add LLM docs to the projects il y a 8 mois
fastlane d7139a8f20 Zip the xcframework folder to allow tool find artifact directly il y a 1 an
images 1869184c7b Protocol indicator il y a 9 ans
.gitignore 197fe75c30 Add gitignore entries for Claude local settings il y a 7 mois
.ruby-version dcdf4c64d1 Update Ruby and Xcode versions il y a 1 an
.spi.yml f17aa80945 Only SPM can build doc correctly il y a 1 an
CHANGELOG.md 7deda23bbd Bump version to 8.3.2 il y a 10 mois
CLAUDE.md 7453b2cbb7 Add LLM docs to the projects il y a 8 mois
CONTRIBUTING.md 04a8d22dfd Fixes broken link in contributing documentation il y a 4 ans
Gemfile bc8558672d Remove doc generate lane il y a 5 ans
Gemfile.lock f66cc8cf63 Upgrade gems il y a 11 mois
Kingfisher.json 7707172289 Add Carthage support for both watchOS and iOS platform il y a 7 mois
Kingfisher.podspec 7deda23bbd Bump version to 8.3.2 il y a 10 mois
LICENSE 107bc366fe Update LICENSE il y a 6 ans
Package.swift 12918567e3 Update support version in Package.swift il y a 2 ans
Package@swift-5.9.swift 6c3f663f59 Merge branch 'master' into v8 il y a 1 an
README-LLM.md 7453b2cbb7 Add LLM docs to the projects il y a 8 mois
README.md 5387e7b3f1 Update doc il y a 1 an

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+