Skip to content

Commit dd6111b

Browse files
committed
Update README.md
1 parent d0b6697 commit dd6111b

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,29 @@ Here's a screenshot of a real app that uses two `CKDotMatrixView` instances to s
1818

1919
## Features
2020

21-
* Can be adjusted to fit almost any size using storyboard settings only.
21+
* Can be adjusted to fit almost any size using storyboard settings only (including live rendering!).
2222
* Uses color information provided in the storyboard.
2323
* Provides some basic animation (to be optimized and extended...)
2424
* Displays a cool glowing around the illuminated dots.
25-
* Comes with one 10 dot font providing numbers and upper case fonts (to be extended...)
25+
* Comes with a 10 dot font providing numbers and upper case fonts (to be extended...)
2626

2727
## Usage
2828

2929
As you can see in the provided demo app, the `CKDotMatrixView` can be added to your app's UI without a single line of code (there's no view controller implementation in that demo app).
3030

3131
Add a `UIView` to your storyboard and set its origin and size appropriately.
3232

33-
Head to the _identity inspector_ and add the following _user defined runtime attributes_:
33+
Head to the _identity inspector_ and set the class to `CKDotMatrixView`. You don't have to add the _user defined runtime attributes_ by yourself (since 0.1.1).
34+
35+
![](CKDotMatrixView_Storyboard1.png)
36+
37+
Go to the _attributes inspector_ and set the following properties in the first section titled _Dot Matrix View_:
3438
* `horizontalDotCount` - number of dots displayed horizontally (mandatory)
3539
* `verticalDotCount` - number of dots displayed vertically (mandatory)
3640
* `text` - the string to be displayed by the dot matrix (optional, can be used for static content)
37-
* `animated` - a flag indicating, wether the content should be initially animated (optional, default is `NO`)
41+
* `animated` - a flag indicating, wether the content should be initially animated (optional, default is `NO`). Please note, that the interface builder's live rendering will be always without animation.
3842

39-
![](CKDotMatrixView_Storyboard1.png)
40-
41-
Go to the _attributes inspector_ and set the background color and the tint color as you like. The illuminated dots will be drawn using the tint color and the dots that are off will be drawn using a slightly lighter color than the background color.
43+
Finally set the background color and the tint color as you like. The illuminated dots will be drawn using the tint color and the dots that are off will be drawn using a slightly lighter color than the background color.
4244

4345
![](CKDotMatrixView_Storyboard2.png)
4446

@@ -50,6 +52,10 @@ You can create your own dot font by providing your own `CKDotMatrixFontMapping`
5052

5153
Christian Klaproth, [@JaNd3r](http://twitter.com/JaNd3r)
5254

55+
## Thanks to...
56+
57+
... [@ivowessel](http://twitter.com/ivowessel) for pointing me at the interface builder's live rendering feature.
58+
5359
## License
5460

5561
`CKDotMatrixView` is available under the MIT license. See the LICENSE file for more info.

0 commit comments

Comments
 (0)