aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: e027dfe4455d3a26ea825c1f858cf76df5dbe72c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
# AboutIt
A About-page creator

## Install

    dependencies {
        implementation 'com.snilius.aboutit:aboutit:1.2.2'
    }

Optionally one may also add the meta module to get some common library presets for free, like Retrofit, Gson, OkHttp, Glide and some more.

    dependencies {
        implementation 'com.snilius.aboutit:aboutit-meta:1.0.1'
    }

## Sample
A complete sample
```java
new AboutIt(this).app(R.string.app_name)
    .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
    .copyright("Example Business")
    .libLicense("AboutIt", "Victor Häggqvist", L.AP2, "https://github.com/victorhaggqvist/aboutit")
    .libLicense(new LibTimber()) // requires aboutit-meta module
    .toTextView(R.id.about_text);
```

Just the dynamic version name and copyright year display
```java
new AboutIt(this).app("My App")
        .buildInfo(BuildConfig.DEBUG, BuildConfig.VERSION_CODE, BuildConfig.VERSION_NAME)
        .copyright("Example Business")
        .toTextView(R.id.about_text);
```

The code for these samples are all in the sample app [here](aboutit-sample/src/main/java/com/snilius/aboutit/sample/MainActivity.java).

<img src="img/img1.png" alt="screenshot" width="300px" height="auto" />
<img src="img/img2.png" alt="screenshot" width="300px" height="auto" />
<img src="img/img3.png" alt="screenshot" width="300px" height="auto" />
<img src="img/img4.png" alt="screenshot" width="300px" height="auto" />

## License

    Copyright 2014-2018 Victor Häggqvist

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.