From 5c39a9d1963c4f06155ebf236c4bc96dd4efe4e5 Mon Sep 17 00:00:00 2001 From: Brian Thorne Date: Wed, 8 Jun 2016 13:39:55 +1000 Subject: [PATCH] Add changelog and update readme with notes on creating a release. --- CHANGELOG | 13 +++++++++++++ README.md | 19 +++++++++++++++---- 2 files changed, 28 insertions(+), 4 deletions(-) create mode 100644 CHANGELOG diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 index 0000000..eca45ec --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,13 @@ +# Version 0.5.0 (2016-06-08) + +- Reconfigurable base. +- command line utility. +- Additional speed improvements using GMP +- Bug fixes. + +# Version 0.4.0 (2015-07-16) + +- Introduction of Paillier Context api +- Significant speed improvements +- Compatibility with Oracle JDK 7 + diff --git a/README.md b/README.md index e3a4e56..f61ca11 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ To use the library add the following dependency to your SBT configuration: libraryDependencies += "com.n1analytics" % "javallier_2.10" % "0.4.2" -Example usages are provided in the `/examples` source directory. A benchmarking script -can be found in `/benchmark`. +Example usages are provided in the `/examples` source directory. A +benchmarking script can be found in `/benchmark`. ## Build @@ -98,12 +98,23 @@ Alternatively you can run directly with sbt: $ javallier decrypt examplekey.priv encD.json 24.0 -Release -------- +Releases +-------- Releases will be signed by Brian Thorne with the PGP key [C18347DE](https://pgp.mit.edu/pks/lookup?op=vindex&search=0x22ADF3BFC18347DE) +Creating a release +~~~~~~~~~~~~~~~~~~ + +Ensure you have sonatype credentials in `~/.sbt/0.13/sonatype.sbt`, and +[install the pgp plugin](http://www.scala-sbt.org/sbt-pgp/) +(`~/.sbt/0.13/plugins/pgp.sbt`). Run `sbt publishSigned`, then visit the +[staging repositories](https://oss.sonatype.org/#stagingRepositories) of +sonatype and **close** the staging repository which will allow you to move +to the release channel. Once you have successfully closed the staging +repository, you can release it by pressing the Release button. + * http://www.scala-sbt.org/release/docs/Using-Sonatype.html * http://central.sonatype.org/pages/releasing-the-deployment.html