Skip to content

Latest commit

 

History

History
188 lines (141 loc) · 5.35 KB

README.md

File metadata and controls

188 lines (141 loc) · 5.35 KB
Raw

Licenser API

An android library to display the licenses of your application libraries in a easy way.

Now with custom licenses support.

Releases:

Current release: 2.0.0.

You can see all the library releases here.

Wiki

You can access Licenser wiki here.

Demo:

You can download the sample apk here.

Usage:

Step: 1 - adding the library via Gradle

First of all add this to your root build.gradle file:

allprojects {
    repositories {
        maven { url "https://jitpack.io" }
    }
}

Now add the dependency to your app build.gradle file:

implementation 'com.github.marcoscgdev:Licenser:2.0.0'

Step: 2 - creating a dialog

You have to use an AppCompatActivity

LicenserDialog(this)
        .setTitle("Licenses")
        .setCustomNoticeTitle("Notices for files:")
        .setBackgroundColor(Color.RED) // Optional
        .setLibrary(Library("Android Support Libraries",
                "https://developer.android.com/topic/libraries/support-library/index.html",
                License.APACHE2)) // APACHE deprecated, see wiki
        .setLibrary(Library("Example Library",
                "https://github.com/marcoscgdev",
                License.APACHE2)) // APACHE deprecated, see wiki
        .setLibrary(Library("Licenser",
                "https://github.com/marcoscgdev/Licenser",
                License.MIT))
        .setPositiveButton(android.R.string.ok, object:DialogInterface.OnClickListener() {
            fun onClick(dialogInterface:DialogInterface, i:Int) {
                // TODO: 11/02/2018
            }
        })
        .show()

You can also set a custom dialog theme:

LicenserDialog(this, R.style.DialogStyle)
        ...

Library structure:

val lib1 = Library(var title: String, var url: String?, var license: License)

NEW: License structure:

// Use a license code like APACHE2 or MIT
val lic1 = License(val code: String, var htmlContent: String)

LICENSE TYPES (At this moment):

 - License.APACHE1 // Apache v1
 - License.APACHE1_1 // Apache v1.1
 - License.APACHE2 // Apache v2
 - License.BSD3 // BSD v3
 - License.BSD4 // BSD v4
 - License.BSL // BSL
 - License.CREATIVE_COMMONS // Creative commons
 - License.FREEBSD // FreeBSD
 - License.GNU2 // GNU v2
 - License.GNU3 // GNU v3
 - License.ISC // ISC
 - License.LGPL2_1 // GNU Lesser v2.1
 - License.LGPL3 // GNU Lesser v3
 - License.MIT // MIT
 - License.MPL1 // MPL v1
 - License.MPL1_1 // MPL v1.1
 - License.MPL2 // MPL v2
 - License.NTP // NTP
 - License.OFL1_1 // SIL Open Font License v1.1

Please, if you need a license that is not yet in this list, try to create a custom license.

val lic1 = License("CUSTOM_LICENSE_CODE", customLicenseHtmlContent)

val lib1 = Library("Library name", "https://github.com/marcoscgdev", lic1)

If you don't want a dialog, you can use the Licenser class:

var licenser = Licenser()
        .setCustomNoticeTitle("Notices for files:")
        .setLibrary(Library("Android Support Libraries",
                "https://developer.android.com/topic/libraries/support-library/index.html",
                License.APACHE))
        .setLibrary(Library("Example Library",
                "https://github.com/marcoscgdev",
                License.APACHE))
        .setLibrary(Library("Licenser",
                "https://github.com/marcoscgdev/Licenser",
                License.MIT))

And show it in a webview:

webView.loadData(licenser.htmlContent, "text/html; charset=UTF-8", null)

Extra functions

You can access this functions with both classes

var licenses = licenser.getHTMLContent() // HTML content
var apacheLibraries = licenser.getApacheLibraries()
var mitLibraries = licenser.getMitLibraries()
var gnuLibraries = licenser.getGnuLibraries()

See the sample project to clarify any queries you may have.

License

The MIT License (MIT)

Copyright (c) 2018 Marcos Calvo García

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.