Skip to content

Commit fd9e180

Browse files
committed
README: Use Title Case for main titles
1 parent 8c2b0d9 commit fd9e180

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Secrets Vault Plugin employs multiple security-enhancing strategies, includi
1111

1212
> Please remember that no client-side security measures are invincible. As a rule of thumb, **storing secrets in a mobile app is not considered best practice**. However, when there's no other option, this method is our best recommendation for concealing them.
1313
14-
# 1) Getting started
14+
# 1) Getting Started
1515

1616
To use the Secrets Vault Plugin in your Android project, follow these steps:
1717

@@ -37,7 +37,7 @@ plugins {
3737
}
3838
```
3939

40-
# 2) Keep secrets in your project
40+
# 2) Keep Secrets in Your Project
4141

4242
To keep secrets in your project, you can add them to a JSON file located in the root folder of the module where you've applied the plugin.
4343
Follow the format below:
@@ -81,7 +81,7 @@ secretsVault {
8181
- The `projectName` parameter is optional and uses the module's name where the plugin is applied by default. You can specify a different project name if needed.
8282
- The `version` parameter is optional. If not provided, a default CMake version will be used.
8383

84-
# 3) Get your secret key in your app
84+
# 3) Get Your Secret Key in Your App
8585
To enable the compilation of C++ files, add these lines in the Module level `build.gradle[.kts]` :
8686
```gradle
8787
android {
@@ -101,7 +101,7 @@ Access your secret key by calling :
101101
val key = MainSecrets().getYourSecretKeyName()
102102
```
103103

104-
# 4) Flavor-specific secrets (Optional)
104+
# 4) Flavor-specific Secrets (Optional)
105105
If you are working on multi-flavor projects and have flavor-specific secrets, you need to pass arguments to CMake in your `build.gradle[.kts]` file. Follow the steps below:
106106

107107
```gradle
@@ -207,7 +207,7 @@ android {
207207
```
208208
Remember to replace version in -Dversion=flavorName with the appropriate cmakeArgument from your JSON. The flavorName should correspond to the specific product flavor you're building for.
209209

210-
# 6) Enhance your secrets security (Optional)
210+
# 6) Enhance Your Secrets' Security (Optional)
211211
To enhance the security of your secrets, you can create a custom encoding/decoding algorithm. The secrets will be stored in C++ and further secured by applying your custom encoding algorithm. Additionally, the decoding algorithm will be compiled, making it more challenging for an attacker to reverse-engineer and obtain your keys.
212212

213213
Encode all values in your `secrets.json` file.

0 commit comments

Comments
 (0)