diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..2920053 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,25 @@ +# Changelog +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [Unreleased] + +## [1.0.0] - 2020-03-03 +### Added +- `WebImage` now supports animation, use `isAnimating` binding value on init methods. +- `WebImage` now supports the detailed animation control options, like `customLoopCount`, `pausable`, `purgeable`, `playbackRate`. +- `AnimatedImage` now supports the indicator with `ViewModifier` as `WebImage`. +- `IndicatorViewModifier` now public. +- `IndicatorReportable` now public. + +### Changed +- Indicator's `progress` type now changed from `CGFloat` to `Double`. +- `WebImage.aniamted(_:)` now becomes the `WebImage.init(url:options:context:isAnimating:)` Binding arg, you can use the Binding to control animations as well. +- `AnimatedImage.playBackRate` now becomes `AnimatedImage.playbackRate` +- `AnimatedImage.customLoopCount` now is `UInt` instead of `Int`. +- `AnimatedImage.resizable` modifier now matches the SwiftUI behavior, you must call it or the size will be fixed to image pixel size. + +### Removed +- Removed all the description about 0.x version behavior in README.md. diff --git a/README.md b/README.md index fff19a1..6c052b4 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,10 @@ The v1.0.0 version is now **released**, which provide all the function above, wi This framework follows [Semantic Versioning](https://semver.org/). Each source-break API changes will bump to a major version. +## Changelog + +This project use [keep a changelog](https://keepachangelog.com/en/1.0.0/) format to record the changes. Check the [CHANGELOG.md](https://github.com/SDWebImage/SDWebImageSwiftUI/blob/master/CHANGELOG.md) about the changes between versions. The changes will also be updated in Release page. + ## Contribution All issue reports, feature requests, contributions, and GitHub stars are welcomed. Hope for active feedback and promotion if you find this framework useful.