Skip to content

Commit

Permalink
Docs updates
Browse files Browse the repository at this point in the history
  • Loading branch information
cioccarellia committed Feb 28, 2024
1 parent 1c709e9 commit 3c48e4e
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 8 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<a href="https://app.codacy.com/manual/cioccarellia/ksprefs/dashboard"><img src="https://api.codacy.com/project/badge/Grade/f10cdbdbe7b84d0ea7a03b755c104e03" alt="Codacy"></a>
<a href="https://kotlinlang.org/docs/releases.html"><img src="https://img.shields.io/badge/kotlin-1.9.22-orange.svg" alt="Kotlin"></a>
<a href="https://source.android.com/setup/start/build-numbers"><img src="https://img.shields.io/badge/min-19-00e676.svg" alt="Android Min Sdk"></a>
<a href="https://source.android.com/setup/start/build-numbers"><img src="https://img.shields.io/badge/compile-33-00e676.svg" alt="Android Compile Version"></a>
<a href="https://source.android.com/setup/start/build-numbers"><img src="https://img.shields.io/badge/compile-34-00e676.svg" alt="Android Compile Version"></a>
<a href="https://github.com/cioccarellia/ksprefs/blob/master/LICENSE.md"><img src="https://img.shields.io/badge/license-Apache%202.0-blue.svg" alt="License"></a>
</p>

Expand Down
11 changes: 7 additions & 4 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@ It offers a consistent syntax for reading and writing values, whilst parameteriz
## Design
The library is built with different stages in mind, each taking input from the previous one:

1. The KsPrefs API allows developers to interface with the main primitives: `pull` and `push`, to read and write values to the storage, respectively;
2.

``` mermaid
graph LR
I[KsPrefs API] --pull()/push()---> D(Dispatcher);
I[KsPrefs API] --pull() / push()---> D(Dispatcher);
D --encrypt---> E[Enclosure]
E --write---> S[Storage];
```

1. `KsPrefs API` allows developers to interface with the main primitives: `pull` and `push`, to read and write values to the storage, respectively;
2. `Dispatcher` takes care of the type mapping and enforces the library specific configurations;
3. `Enclosure` physically encrypts and decrypts the data to/from permanent storage;
4. `Storage` is written to using the actual `SharedPreferences` APIs



## Samples
6 changes: 3 additions & 3 deletions docs/pages/overview/dependencies_integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ repositories {

### Project Requirements

- Java 8+ is required;
- Java 17+ is required;
```groovy
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}
```
- `minSdk` 19+ is required.
Expand Down

0 comments on commit 3c48e4e

Please sign in to comment.