hazer / aboutlibraries Goto Github PK

#AboutLibraries

The AboutLibraries library allows you to easily create an used open source libraries fragment/activity within your app. As an extra feature you can also add an about this app section.

Here's a quick overview of functions it include:

• used open source libraries
  • name, description, creator, license, version, ...
• about this app section (optional)
• autodetect libraries
• many included library details
• automatic created fragment/activity
• feature rich builder to simply create and start the fragment / activity
• much much more... try the sample for a quick overview.

#Motivation

Most modern apps feature an "Used Library"-section and for this some information of those libs is required. As it gets annoying to copy those strings always to your app I've developed this small helper library to provide the required information.

#Migration

• MIGRATION GUIDE

#Get started

• Include in your project
• Usage
• Contribute

#More...

• Sample (Google Play Store)
• Create new definition files
• Get detailed instructions in the wiki
• Compatible/included libs

#Screenshots

#Wiki You can find anything you search for in the wiki. (If not open an issue)

Bring me to the wiki

##Include in your project ###Using Maven The AboutLibraries Library is pushed to Maven Central, so you just need to add the following dependency to your build.gradle. It seems it is also required to add the support dependencies to the application. If it works without, you should be fine too :).

compile('com.mikepenz:aboutlibraries:5.6.5@aar') {
	transitive = true
}

Further information and how to use it if you can't update to the newest v21 support libs can be found in the wiki

##Usage You can use this library in a few different ways. You can create your own activity, including a custom style and just use the information, or you can use the built-in Activity or Fragment and just pass the libs you would love to include.

###Upgrade Notes

Changed maven group. You can get all updates via the new one com.mikepenz:aboutlibraries:5.y.z@aar The Libs.Builder is no more. It was changed to LibsBuilder. Just remove the "." and it is working again.

###Activity / Fragment ####Fragment

LibsFragment fragment = new LibsBuilder()
        //get the fragment
        .fragment();

####Activity #####Code:

new LibsBuilder()
        //provide a style (optional) (LIGHT, DARK, LIGHT_DARK_TOOLBAR)
        .withActivityStyle(Libs.ActivityStyle.LIGHT_DARK_TOOLBAR)
        //start the activity
        .start(this);

##Small extra For those who read the whole README here's one more thing. You can also use the AboutLibraries activity as an "about this app" screen. You ask how? Yeah pretty simple just add the following .xml file (or just the strings - the key must be the same) to your project.

<resources>
    <string name="aboutLibraries_description_showIcon">true</string>
    <string name="aboutLibraries_description_showVersion">true</string>
    <string name="aboutLibraries_description_text">Place your description here :D</string>
</resources>

or use the builder and add following:

	.withAboutIconShown(true)
	.withAboutVersionShown(true)
	.withAboutDescription("This is a small sample which can be set in the about my app description file.<br /><b>You can style this with html markup :D</b>")

##ProGuard Exclude R from ProGuard to enable the library auto detection

-keep class .R
-keep class **.R$* {
    <fields>;
}

##Contribute You can contribute by creating a information file for a new library, and open a pull-request at the creators Git repository. If he doesn't include the information file in his repo, or if the library isn't maintained anymore you can create a pull-request here. Find more information in the wiki Create a definition file

##Already in use in following apps (feel free to send me new projects)

• wallsplash
• Numbers
• MegaYatzy
• Sir Spellalot
• TVShow Time
• Strength
• Sprit Club
• Hold'Em Poker Manager
• PixCell8
• ML Manager
• TurnMe Panorama
• Navig'Tours

#Developed By

• Mike Penz
• mikepenz.com - [email protected]
• paypal.me/mikepenz

#License

Copyright 2016 Mike Penz

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.