Skip to content

Commit 24299f0

Browse files
Updated Readme
1 parent 5b49b8c commit 24299f0

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1+
![icon](docs/icon.svg)
2+
13
# SwiftChips 🍟
24

35
[![MIT License][license-image]][license-url]
6+
[![swift version](https://img.shields.io/badge/swift-5.0+-brightgreen.svg)](https://swift.org/download)
7+
[![Platform](https://img.shields.io/badge/platforms-iOS-blue.svg)](https://developer.apple.com/platforms/)
48
[![SwiftPM compatible](https://img.shields.io/badge/SwiftPM-compatible-brightgreen?style=flat)](https://swift.org/package-manager)
59

610
A SwiftUI implementation for chips. Chips allow users to view information, make selections, filter content, and enter data.
@@ -17,15 +21,21 @@ The library support 3 different modes:
1721

1822
In this mode the user can only select 1 chip at a time, or none.
1923

24+
![single_selection](docs/single.gif)
25+
2026
### Multiple Selection work mode
2127

2228
In this mode the user can only select from 0 to all chips.
2329

30+
![multiple_selection](docs/multiple.gif)
31+
2432
### Delete mode.
2533

2634
In this mode the user cannot select the chips, but eventually is possible to delete
2735
them.
2836

37+
![deletable](docs/deletable.gif)
38+
2939
## How to use it
3040

3141
WIP a detailed guide
@@ -37,9 +47,9 @@ WIP a detailed guide
3747
3. Select "Up to Next Major" with `0.1.0`
3848

3949

40-
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
41-
[license-url]: LICENSE.md
42-
4350
## Known Bugs
4451

4552
- Currently the wrapper of the chips do not layout the vertical height correctly. _workaround_ add a `.padding` on the bottom
53+
54+
[license-image]: http://img.shields.io/badge/license-MIT-000000.svg?style=flat-square
55+
[license-url]: LICENSE.md

docs/deletable.gif

69 KB
Loading

docs/icon.svg

Lines changed: 10 additions & 0 deletions
Loading

docs/multiple.gif

137 KB
Loading

docs/single.gif

179 KB
Loading

0 commit comments

Comments
 (0)