README: Add crypto docs
This commit is contained in:
parent
bc220c470a
commit
fcb9f37985
1 changed files with 11 additions and 0 deletions
11
README.md
11
README.md
|
|
@ -102,6 +102,17 @@ Deserialize it:
|
|||
|
||||
Couldn't be simpler!
|
||||
|
||||
### Encryption (currently in **ALPHA**)
|
||||
|
||||
As of 1.3.0, Nippy also gives you **dead simple data encryption**. Add a single flag to your usual freeze/thaw calls like so:
|
||||
|
||||
```clojure
|
||||
(nippy/freeze-to-bytes nippy/stress-data :password [:salted "my-password"]) ; Encrypt
|
||||
(nippy/thaw-from-bytes <encrypted-data> :password [:salted "my-password"]) ; Decrypt
|
||||
```
|
||||
|
||||
There's two forms of encryption on offer: `:salted` and `:cached`. Each of these makes carefully-chosen trade-offs and is suited to one of two common use cases. See the `aes128-salted` and `aes128-cached` [docstrings](http://ptaoussanis.github.io/nippy/taoensso.nippy.crypto.html) for a detailed explanation of why/when you'd want one or the other.
|
||||
|
||||
## Performance
|
||||
|
||||

|
||||
|
|
|
|||
Loading…
Reference in a new issue