Skip to content

Commit ed7630d

Browse files
committed
DOCS : Updated documentation
1 parent 53d7a19 commit ed7630d

2 files changed

Lines changed: 45 additions & 6 deletions

File tree

CHANGELOG.MD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
No release at the moment
1+
This file will not be updated until the first public release

README.MD

Lines changed: 44 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,50 @@ with ```android:drawableStart``` etc... or in code with
99

1010
## Demo GIF
1111

12-
TODO add demo GIF (maybe hosted on my domain)
13-
12+
TODO add demo GIF
1413

1514
## Installing
1615

17-
TODO (waiting for jcenter approval)
16+
I'm waiting for jcenter support team to approve the library
17+
18+
To let the library work correctly, the first thing you need to call is
19+
```CsDrawableSettings.init(Context context, String packageName)```
20+
21+
I suggest you to init the library at the end of ```onCreate()``` method of your
22+
custom ```Application``` class,
23+
If you dont have a custom ```Application``` class, you can create one like this:
24+
25+
```java
26+
public class AppApplication extends Application {
27+
@Override
28+
public void onCreate() {
29+
super.onCreate();
30+
//Init the library
31+
CsDrawableSettings.init(this, BuildConfig.APPLICATION_ID);
32+
}
33+
}
34+
```
35+
then you need to change your ```AndroidManifest.xml``` to load your custom
36+
application class instead of the default one adding the
37+
```android:name".AppApplication"``` (you should update the path accordingly based
38+
on where you create the ```AppApplication``` class) to the manifest.
39+
40+
Something similar to this:
41+
```
42+
<application
43+
android:name=".AppApplication"
44+
android:allowBackup="true"
45+
android:icon="@mipmap/ic_launcher"
46+
android:supportsRtl="true"
47+
....>
48+
49+
<!-- Other declarations -->
50+
51+
</application>
52+
```
53+
1854

19-
## API Docs
55+
## Docs
2056

2157
The library provides 3 views with extended functionalities for drawables.
2258

@@ -31,7 +67,10 @@ Those are:
3167
Each of them it's extending the ```AppCompat``` counterpart for max
3268
compatibility with every SDK version.
3369

34-
You can add a ```CsDrawable``` via XML or via Code, below i will show you both the implementations
70+
The custom drawables are ```CsDrawable```s objects.
71+
72+
You can add a ```CsDrawable``` via XML or via Code,
73+
below you can find both the implementations
3574

3675
#### XML
3776
After declaring

0 commit comments

Comments
 (0)