diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..c64ac27 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,37 @@ +## v1.2.1 → v2.0.0-RC1 + * Refactored for huge performance improvements (~40% roundtrip time). + * New header format for better error messages. + * New `taoensso.nippy.tools` ns for easier integration with 3rd-party tools. + + * **DEPRECATED**: `freeze-to-bytes` -> `freeze`, `thaw-from-bytes` -> `thaw`. + See the new fn docstrings for updated opts, etc. + + * Added pluggable compression support: + ```clojure + (freeze "Hello") ; defaults to: + (freeze "Hello" {:compressor taoensso.nippy.compression/snappy-compressor}) + + ;; The :compressor value above can be replaced with nil (no compressor) or + ;; an alternative Compressor implementing the appropriate protocol + ``` + + * Added pluggable crypto support: + ```clojure + (freeze "Hello") ; defaults to: + (freeze "Hello" {:encryptor taoensso.nippy.encryption/aes128-encryptor} + + ;; The :encryptor value above can be replaced with nil (no encryptor) or + ;; an alternative Encryptor implementing the appropriate protocol + ``` + + See the [README](https://github.com/ptaoussanis/nippy#encryption-currently-in-alpha) for an example using encryption. + + +## For older versions please see the [commit history][] + +[commit history]: https://github.com/ptaoussanis/nippy/commits/master +[API docs]: http://ptaoussanis.github.io/nippy +[Taoensso libs]: https://www.taoensso.com/clojure-libraries +[Nippy GitHub]: https://github.com/ptaoussanis/nippy +[Nippy CHANGELOG]: https://github.com/ptaoussanis/carmine/blob/master/CHANGELOG.md +[Nippy API docs]: http://ptaoussanis.github.io/nippy \ No newline at end of file diff --git a/README.md b/README.md index 247aeb5..a4acd64 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -**[API docs](http://ptaoussanis.github.io/nippy/)** | [contact & contributing](#contact--contributing) | [other Clojure libs](https://www.taoensso.com/clojure-libraries) | [Twitter](https://twitter.com/#!/ptaoussanis) | current [semantic](http://semver.org/) version: +**[API docs](http://ptaoussanis.github.io/nippy/)** | **[CHANGELOG](https://github.com/ptaoussanis/nippy/blob/master/CHANGELOG.md)** | [contact & contributing](#contact--contributing) | [other Clojure libs](https://www.taoensso.com/clojure-libraries) | [Twitter](https://twitter.com/#!/ptaoussanis) | current [semantic](http://semver.org/) version: ```clojure [com.taoensso/nippy "1.2.1"] ; Stable