Skip to content

Commit

Permalink
feat: Update README and CHANGELOG file
Browse files Browse the repository at this point in the history
  • Loading branch information
Juanpe Catalán committed Aug 2, 2018
1 parent 3f7f2ec commit 9fbaaa0
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 2 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# Change Log
All notable changes to this project will be documented in this file

## [Custom defaults (1.3)](https://github.com/Juanpe/SkeletonView/releases/tag/1.3)

### New

- Default values customizables. Now you can set the default values of Skeleton appearance.(thanks @reececomo)
- issues: [[#50](https://github.com/Juanpe/SkeletonView/issues/50), [#83](https://github.com/Juanpe/SkeletonView/issues/83)]

### Bug fixes
- Solved issue [#41](https://github.com/Juanpe/SkeletonView/issues/41). Now, Skeleton works if UICollectionView cell's Nib is registered in code. (thanks @kjoneandrei)

## [Typo (1.2.3)](https://github.com/Juanpe/SkeletonView/releases/tag/1.2.3)

### Fixes
Expand Down
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ Enjoy it! 🙂
* [Collections](#-collections)
* [Multiline text](#-multiline-text)
* [Custom colors](#-custom-colors)
* [Appearance](#-appearance)
* [Custom animations](#-custom-animations)
* [Hierarchy](#-hierarchy)
* [Documentation](#-documentation)
Expand Down Expand Up @@ -273,9 +274,22 @@ Besides, ```SkeletonView``` features 20 flat colors 🤙🏼
![](Assets/flatcolors.png)
###### Image captured from website [https://flatuicolors.com](https://flatuicolors.com)

### 🦋 Appearance

**NEW** The skeletons have a default appearance. So, when you don't specify the color, gradient or multilines properties, `SkeletonView` uses the default values.

Default values:
- **tintColor**: UIColor
- **gradient**: SkeletonGradient
- **multilineHeight**: CGFloat
- **multilineSpacing**: CGFloat
- **multilineLastLineFillPercent**: Int
- **multilineCornerRadius**: Int _0_


### 🤓 Custom animations

Now, ```SkeletonView``` has two built-in animations, *pulse* for solid skeletons and *sliding* for gradients.
```SkeletonView``` has two built-in animations, *pulse* for solid skeletons and *sliding* for gradients.

Besides, if you want to do your own skeleton animation, it's really easy.

Expand All @@ -297,7 +311,7 @@ view.showAnimatedSkeleton { (layer) -> CAAnimation in
}
```

**NEW** It's available ```SkeletonAnimationBuilder```. It's a builder to make ```SkeletonLayerAnimation```.
It's available ```SkeletonAnimationBuilder```. It's a builder to make ```SkeletonLayerAnimation```.

Today, you can create **sliding animations** for gradients, deciding the **direction** and setting the **duration** of the animation (default = 1.5s).

Expand Down Expand Up @@ -352,6 +366,7 @@ Coming soon...😅
* [x] CollectionView compatible
* [x] tvOS compatible
* [x] Add recovery state
* [x] Custom default appearance
* [ ] Custom collections compatible
* [ ] Add animations when it shows/hides the skeletons
* [ ] MacOS and WatchOS compatible
Expand Down

0 comments on commit 9fbaaa0

Please sign in to comment.