Skip to content

Commit

Permalink
feat: Update CHANGELOG file
Browse files Browse the repository at this point in the history
  • Loading branch information
Juanpe committed Aug 10, 2018
1 parent 88914f7 commit 25e3138
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 15 deletions.
14 changes: 14 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Change Log
All notable changes to this project will be documented in this file

## [Debug (1.4)](https://github.com/Juanpe/SkeletonView/releases/tag/1.4)

### New

- Create `skeletonDescription` print a skeleton representation of the view.
- Create `SKELETON_DEBUG` environment variable, in order to print the view hierarchy when the skeleton appears.

### Improvements
- Add two new methods to `SkeletonFlowDelegate` protocol. Now you can know when the skeleton did show and when it did hide.
- `Recursive` protocol

### Bug fixes
- Solved issue [#86](https://github.com/Juanpe/SkeletonView/issues/86) (thanks @reececomo)

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

### New
Expand Down
29 changes: 14 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -369,29 +369,28 @@ Because an image is worth a thousand words:

### 🔬 Debug

**NEW** In order to facilitate the debug tasks when something is not working fine. `SkeletonView` has a **debug mode**.
**NEW** In order to facilitate the debug tasks when something is not working fine. `SkeletonView` has some new tools.

To activate the debug mode, you need to create an Environment variable and activate it.
First, `UIView` has available a new property with his skeleton info:
```swift
var skeletonDescription: String

![](Assets/debug_mode.png)
```
The skeleton representation looks like this:

Then, when skeleton is showed, `SkeletonView` will print the hierarchy.
![](Assets/debug_description.png)

<details><summary>Open to see an output example </summary>
<p>
![](Assets/hierarchy_output.png)
</p>
</details>
Besides, you can activate the new **debug mode**. You just add the environment variable `SKELETON_DEBUG` and activate it.

![](Assets/debug_mode.png)

Besides, `UIViews` have available a new property with skeleton info:
```swift
var skeletonDescription: String
Then, when the skeleton appears, you can see the view hierarchy in the Xcode console.

```
This is his output:
<details>
<summary>Open to see an output example </summary>
![](Assets/hierarchy_output.png)
</details>

![](Assets/debug_description.png)


### 📚 Documentation
Expand Down

0 comments on commit 25e3138

Please sign in to comment.