Skip to content

Commit

Permalink
modified: updated README.md and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
HussainDerry committed Jul 24, 2018
1 parent e9e1620 commit 25119cc
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 3 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,23 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/)
and this project adheres to [Semantic Versioning](http://semver.org/).

## [3.0.0] - 2018-07-24

### Added

* `CipherService` that supports different encryption algorithms.
* TripleDES support.

### Changed

* Modified `Cryptor` and `SecurityConfig` to support the new algorithm selection feature.

### Removed

* AES related classes in favor of the new `CipherService`.

## [2.1.1] - 2017 -06-23

### Changed
- Modified `Cryptor` to use the `String.format()` method instead of using the StringBuilder class.

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
## Secure Preferences [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.hussainderry/secure-preferences/badge.svg?style=plastic)](https://maven-badges.herokuapp.com/maven-central/com.github.hussainderry/secure-preferences) [![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Secure%20Preferences-brightgreen.svg?style=plastic)](https://android-arsenal.com/details/1/5403) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/7f81fd82dae444d38e783f72bfd951d5)](https://www.codacy.com/app/hussain.derry/secure-preferences?utm_source=github.com&utm_medium=referral&utm_content=HussainDerry/secure-preferences&utm_campaign=Badge_Grade)

A simple library that provides an AES encrypted version of the Android shared preferences
A simple library that provides an encrypted version of the Android shared preferences.
Current supported algorithms (AES, TripleDES).

## Setup

#### Gradle

`compile 'com.github.hussainderry:secure-preferences:2.1.1'`
`compile 'com.github.hussainderry:secure-preferences:3.0.0'`

## Sample Usage
### Configuring Encryption Parameters
Expand All @@ -20,6 +21,7 @@ SecurityConfig fullConfig = new SecurityConfig.Builder(PASSWORD)
.setAesKeySize(256) // key size in bits
.setPbkdf2SaltSize(32) // salt size in bytes
.setPbkdf2Iterations(24000)
.setEncryptionAlgorithm(EncryptionAlgorithm.AES)
.setDigestType(DigestType.SHA256)
.build();

Expand All @@ -42,7 +44,7 @@ if(mFuture.isDone()){
## Developed By

* Hussain Al-Derry

   **Email** - [email protected]

## License
Expand Down

0 comments on commit 25119cc

Please sign in to comment.