diff --git a/LICENSE b/LICENSE index f433b1a5..7a4a3ea2 100644 --- a/LICENSE +++ b/LICENSE @@ -175,3 +175,28 @@ of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. \ No newline at end of file diff --git a/README.md b/README.md index 601f1027..5206e0f2 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,9 @@ -Analytics plugin -================ +# Analytics plugin +![Maven Central](https://img.shields.io/maven-central/v/org.kill-bill.billing.plugin.java/analytics-plugin?color=blue&label=Maven%20Central) Kill Bill plugin to provide business analytics and reporting capabilities. You can find the documentation [here](http://docs.killbill.io/latest/userguide_analytics.html). -Release builds are available on [Maven Central](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.kill-bill.billing.plugin.java%22%20AND%20a%3A%22analytics-plugin%22) with coordinates `org.kill-bill.billing.plugin.java:analytics-plugin`. - -Kill Bill compatibility ------------------------ +## Kill Bill compatibility | Plugin version | Kill Bill version | | -------------: | ----------------: | @@ -15,15 +12,16 @@ Kill Bill compatibility | 4.x.y | 0.18.z | | 5.x.y | 0.19.z | | 6.x.y | 0.20.z | -| 7.x.y | 0.22.z | +| 7.0.y | 0.22.z | +| 7.1.y | 0.22.z | + +We've upgraded numerous dependencies in 7.1.x (required for Java 11 support). -Requirements ------------- +## Requirements The plugin needs a database. The latest version of the schema can be found [here](https://github.com/killbill/killbill-analytics-plugin/blob/master/src/main/resources/org/killbill/billing/plugin/analytics/ddl.sql). -Setup ------ +## Setup Default dashboards rely on reports that need to be installed by running the [seed_reports.sh](https://github.com/killbill/killbill-analytics-plugin/blob/master/src/main/resources/seed_reports.sh) script. @@ -31,8 +29,7 @@ By default, the views will use the *converted* amount columns when applicable, w When configuring refreshes via stored procedures, make sure to bump the connection timeout accordingly (`org.killbill.billing.osgi.dao.connectionTimeout`), as it will be used to set the read and query timeouts. -API ---- +## API ### Data @@ -152,3 +149,7 @@ curl -v \ -u admin:password \ "http://127.0.0.1:8080/plugins/killbill-analytics/healthcheck" ``` + +## About + +Kill Bill is the leading Open-Source Subscription Billing & Payments Platform. For more information about the project, go to https://killbill.io/. diff --git a/pom.xml b/pom.xml index 02c54f32..464704ea 100644 --- a/pom.xml +++ b/pom.xml @@ -25,7 +25,7 @@ org.kill-bill.billing.plugin.java analytics-plugin - 7.0.9-SNAPSHOT + 7.1.0-SNAPSHOT bundle Kill Bill OSGI Analytics bundle Kill Bill Analytics plugin