Generate README.md from template file to avoid stale version numbers

Author: developernotes

README.md

@@ -13,6 +13,12 @@ We welcome contributions, to contribute to SQLCipher for Android, a [contributor
 
 ### Application Integration
 
+When available on Maven Central, add a reference to the library and dependency:
+
+```
+implementation "net.zetetic:sqlcipher-android:4.4.3"
+implementation "androidx.sqlite:sqlite:2.1.0"
+```
 
 ```
 import net.zetetic.database.sqlcipher.SQLiteDatabase;

README.md.template

@@ -0,0 +1,60 @@
+# SQLCipher for Android
+
+SQLCipher for Android provides a library replacement for `android.database.sqlite` on the Android platform for use on [SQLCipher](https://github.com/sqlcipher/sqlcipher) databases. This library is based on the upstream Android Bindings project and aims to be a long-term replacement for the original [SQLCipher for Android](https://github.com/sqlcipher/android-database-sqlcipher) library.
+
+### Compatibility
+
+SQLCipher for Android supports Android API 16 and up on `armeabi-v7a`, `x86`, `x86_64`, and `arm64_v8a` architectures.
+
+### Contributions
+
+We welcome contributions, to contribute to SQLCipher for Android, a [contributor agreement](https://www.zetetic.net/contributions/) needs to be submitted. All submissions should be based on the `master` branch.
+
+
+### Application Integration
+
+When available on Maven Central, add a reference to the library and dependency:
+
+```
+implementation "net.zetetic:sqlcipher-android:<%=libraryVersion%>"
+implementation "androidx.sqlite:sqlite:<%=androidXSQLiteVersion%>"
+```
+
+```
+import net.zetetic.database.sqlcipher.SQLiteDatabase;
+
+System.loadLibrary("sqlcipher");
+SQLiteDatabase database = SQLiteDatabase.openOrCreateDatabase(databaseFile, password, null, null, null);
+```
+
+### Pre/Post Key Operations
+
+To perform operations on the database instance immediately before or after the keying operation is performed, provide a `SQLiteDatabaseHook` instance when creating your database connection:
+
+```
+SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
+      public void preKey(SQLiteConnection connection) { }
+      public void postKey(SQLiteConnection connection) { }
+    };
+```
+
+### Building 
+
+This repository is not batteries-included. Specificially, you will need to build `libcrypto.a`, the static library from OpenSSL using the NDK for the [supported platforms](#compatibility), and bundle the top-level `include` folder from OpenSSL. Additionally, you will need to build a SQLCipher amalgamation. These files will need to be placed in the following locations:
+
+```
+<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/armeabi-v7a/libcrypto.a
+<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86/libcrypto.a
+<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/x86_64/libcrypto.a
+<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/arm64_v8a/libcrypto.a
+<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/include/
+<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.c
+<project-root>/sqlcipher/src/main/jni/sqlcipher/sqlite3.h
+```
+
+To build the AAR package, either build directly within Android Studio, or from the command line:
+
+```
+./gradlew assembleRelease
+```
+

build.gradle

@@ -1,4 +1,5 @@
-// Top-level build file where you can add configuration options common to all sub-projects/modules.
+import groovy.text.SimpleTemplateEngine
+
 buildscript {
     repositories {
         jcenter()
@@ -24,6 +25,7 @@ allprojects {
 
 project.ext {
     libraryVersion = "4.4.3"
+    androidXSQLiteVersion = "2.1.0"
     mavenLocalRepositoryPrefix = "file://"
     if(project.hasProperty('publishLocal') && publishLocal.toBoolean()){
         mavenSnapshotRepositoryUrl = "outputs/snapshot"
@@ -68,3 +70,19 @@ nexusPublishing {
         }
     }
 }
+
+task generateReadMe {
+    def readme = new File("README.md")
+    def engine = new SimpleTemplateEngine()
+    def reader = new FileReader("README.md.template")
+    def binding = [
+                    libraryVersion: project.ext.libraryVersion,
+                    androidXSQLiteVersion: project.ext.androidXSQLiteVersion
+                  ]
+    def template = engine.createTemplate(reader).make(binding)
+    readme.write(template.toString())
+}
+
+project.afterEvaluate {
+    build.dependsOn generateReadMe
+}

sqlcipher/build.gradle

@@ -51,7 +51,7 @@ dependencies {
     implementation fileTree(include: ['*.jar'], dir: 'libs')
 
     // Needed for the Support API interfaces
-    implementation 'androidx.sqlite:sqlite:2.1.0'
+    implementation "androidx.sqlite:sqlite:${rootProject.ext.androidXSQLiteVersion}"
 
     // Needed for the Support API in tests
     androidTestImplementation 'androidx.room:room-common:2.3.0'