Visitar URL original
Update README for beta · sqlcipher/sqlcipher-android@73ea06a · GitHub
Skip to content

Commit 73ea06a

Browse files
developernotesdevelopernotes
committed
Update README for beta
1 parent 3aeece6 commit 73ea06a

2 files changed

Lines changed: 23 additions & 13 deletions

File tree

‎README.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
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](https://www.sqlite.org/android/doc/trunk/www/index.wiki) project and aims to be a long-term replacement for the original [SQLCipher for Android](https://github.com/sqlcipher/android-database-sqlcipher) library.
44

5+
> [!CAUTION]
6+
> ## SQLCipher 5.0.0-beta details
7+
> Summary:
8+
> - Changes architecture to use VFS shims
9+
> - Uses AEAD Encryption with AES-256-GCM
10+
> - Increases KDF iteration increase to 512K
11+
> - Increase default page size to 8192 bytes
12+
> - Adds encryption and decryption support to PRAGMA rekey
13+
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/v5.0.0-beta/CHANGELOG.md#500-beta----2026---500-beta-changes) and [release announcement](https://www.zetetic.net/blog/2026/09/15/sqlcipher-5.0.0-beta/)
14+
515
### Compatibility
616

717
SQLCipher for Android supports Android API 23 and up on `armeabi-v7a`, `x86`, `x86_64`, and `arm64-v8a` architectures.
@@ -16,16 +26,11 @@ We welcome contributions, to contribute to SQLCipher for Android, a [contributor
1626
Add a local reference to the local library and dependency:
1727

1828
```groovy
19-
implementation files('libs/sqlcipher-android-4.19.0-release.aar')
29+
implementation files('libs/sqlcipher-android-5.0.0-beta-release.aar')
2030
implementation 'androidx.sqlite:sqlite:2.7.0'
2131
```
2232

23-
or source a Community edition build from Maven Central:
24-
25-
```groovy
26-
implementation 'net.zetetic:sqlcipher-android:4.19.0@aar'
27-
implementation 'androidx.sqlite:sqlite:2.7.0'
28-
```
33+
Beta builds are not distributed via Maven Central, but rather through [GitHub Releases](https://github.com/sqlcipher/sqlcipher-android/releases).
2934

3035
```java
3136
import net.zetetic.database.sqlcipher.SQLiteDatabase;

‎README.md.template‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,16 @@
22

33
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](https://www.sqlite.org/android/doc/trunk/www/index.wiki) project and aims to be a long-term replacement for the original [SQLCipher for Android](https://github.com/sqlcipher/android-database-sqlcipher) library.
44

5+
> [!CAUTION]
6+
> ## SQLCipher 5.0.0-beta details
7+
> Summary:
8+
> - Changes architecture to use VFS shims
9+
> - Uses AEAD Encryption with AES-256-GCM
10+
> - Increases KDF iteration increase to 512K
11+
> - Increase default page size to 8192 bytes
12+
> - Adds encryption and decryption support to PRAGMA rekey
13+
> - **BREAKING CHANGES** - see [CHANGELOG.md](https://github.com/sqlcipher/sqlcipher/blob/v5.0.0-beta/CHANGELOG.md#500-beta----2026---500-beta-changes) and [release announcement](https://www.zetetic.net/blog/2026/09/15/sqlcipher-5.0.0-beta/)
14+
515
### Compatibility
616

717
SQLCipher for Android supports Android API <%=minSdkVersion%> and up on `armeabi-v7a`, `x86`, `x86_64`, and `arm64-v8a` architectures.
@@ -20,12 +30,7 @@ implementation files('libs/sqlcipher-android-<%=libraryVersion%>-release.aar')
2030
implementation 'androidx.sqlite:sqlite:<%=androidXSQLiteVersion%>'
2131
```
2232

23-
or source a Community edition build from Maven Central:
24-
25-
```groovy
26-
implementation 'net.zetetic:sqlcipher-android:<%=libraryVersion%>@aar'
27-
implementation 'androidx.sqlite:sqlite:<%=androidXSQLiteVersion%>'
28-
```
33+
Beta builds are not distributed via Maven Central, but rather through [GitHub Releases](https://github.com/sqlcipher/sqlcipher-android/releases).
2934

3035
```java
3136
import net.zetetic.database.sqlcipher.SQLiteDatabase;

0 commit comments

Comments
 (0)