Skip to content

Commit f32ddd1

Browse files
Updates to README template
1 parent fe3be94 commit f32ddd1

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# SQLCipher for Android
22

3-
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.
3+
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.
4+
5+
***N.B.*** This library is currently distributed in source-only format at this time, and requires [other external dependencies](#external-dependencies) to build. Community edition AAR artifacts will be distributed eventually.
46

57
### Compatibility
68

@@ -13,11 +15,11 @@ We welcome contributions, to contribute to SQLCipher for Android, a [contributor
1315

1416
### Application Integration
1517

16-
When available on Maven Central, add a reference to the library and dependency:
18+
Add a reference to the local library and dependency:
1719

1820
```
19-
implementation "net.zetetic:sqlcipher-android:4.5.1"
20-
implementation "androidx.sqlite:sqlite:2.1.0"
21+
implementation files('libs/sqlcipher-android-4.5.1-release.aar')
22+
implementation 'androidx.sqlite:sqlite:2.1.0'
2123
```
2224

2325
```
@@ -44,9 +46,9 @@ SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
4446

4547
Currently, SQLCipher for Android uses NDK version "23.0.7599858".
4648

47-
## External dependencies:
49+
## <a name="external-dependencies" />External dependencies:
4850

49-
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:
51+
This repository is not batteries-included. Specifically, 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:
5052

5153
```
5254
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/armeabi-v7a/libcrypto.a

README.md.template

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# SQLCipher for Android
22

3-
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.
3+
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.
4+
5+
***N.B.*** This library is currently distributed in source-only format at this time, and requires [other external dependencies](#external-dependencies) to build. Community edition AAR artifacts will be distributed eventually.
46

57
### Compatibility
68

@@ -13,11 +15,11 @@ We welcome contributions, to contribute to SQLCipher for Android, a [contributor
1315

1416
### Application Integration
1517

16-
When available on Maven Central, add a reference to the library and dependency:
18+
Add a reference to the local library and dependency:
1719

1820
```
19-
implementation "net.zetetic:sqlcipher-android:<%=libraryVersion%>"
20-
implementation "androidx.sqlite:sqlite:<%=androidXSQLiteVersion%>"
21+
implementation files('libs/sqlcipher-android-4.5.1-release.aar')
22+
implementation 'androidx.sqlite:sqlite:<%=androidXSQLiteVersion%>'
2123
```
2224

2325
```
@@ -44,9 +46,9 @@ SQLiteDatabaseHook hook = new SQLiteDatabaseHook() {
4446

4547
Currently, SQLCipher for Android uses NDK version "<%=androidNdkVersion%>".
4648

47-
## External dependencies:
49+
## <a name="external-dependencies" />External dependencies:
4850

49-
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:
51+
This repository is not batteries-included. Specifically, 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:
5052

5153
```
5254
<project-root>/sqlcipher/src/main/jni/sqlcipher/android-libs/armeabi-v7a/libcrypto.a

0 commit comments

Comments
 (0)