Merge pull request #80 from hardbyte/update-readme

Update Readme

Author: wilko77

README.rst

@@ -9,14 +9,30 @@ python-paillier  |release|
 |      |reqM|         |
 +---------------------+
 
-A Python 3 library for Partially Homomorphic Encryption.
+A Python 3 library implementing the Paillier Partially Homomorphic Encryption.
 
 The homomorphic properties of the paillier crypto system are:
 
 -  Encrypted numbers can be multiplied by a non encrypted scalar.
 -  Encrypted numbers can be added together.
 -  Encrypted numbers can be added to non encrypted scalars.
 
+Citing
+======
+
+`python-paillier` is designed, developed and supported by `CSIRO's Data61 <https://www.data61.csiro.au/>`__. If
+you use any part of this library in your research, please cite it using the following BibTex entry::
+
+    @misc{PythonPaillier,
+      author = {CSIRO's Data61},
+      title = {Python Paillier Library},
+      year = {2013},
+      publisher = {GitHub},
+      journal = {GitHub Repository},
+      howpublished = {\url{https://github.com/data61/python-paillier}},
+    }
+
+
 Running unit tests
 ------------------
 
@@ -28,6 +44,7 @@ Or use nose::
 
    nosetests
 
+
 Note related to gmpy2
 ---------------------
 
@@ -47,12 +64,6 @@ Developed at `Data61 | CSIRO <http://data61.csiro.au>`_.
 Parts derived from the Apache licensed Google project:
 https://code.google.com/p/encrypted-bigquery-client/
 
-No audit
---------
-
-This code has neither been written nor vetted by any sort of crypto
-expert. The crypto parts are mercifully short, however.
-
 
 .. |release| image:: https://img.shields.io/pypi/v/phe.svg
     :target: https://pypi.python.org/pypi/phe/

docs/compatibility.rst

@@ -7,11 +7,11 @@ This library may, with *care*, be used with other Paillier implementations. Keep
 the generator g of the public key is fixed to g = n + 1 (for efficiency reasons) and cannot arbitrarily be 
 chosen as described in the Paillier paper.
 
-- `Javallier <https://github.com/NICTA/javallier/>`_ - library for Java/Scala also maintained by NICTA. Somewhat
-  different Encoding scheme. Base of 2 is fixed (see :ref:`alternative-base`)
-- `paillier.js <https://github.com/hardbyte/paillier.js>`_ - Early prototype library for Javascript/Typescript
-
 
+- `Paillier.jl <https://github.com/hardbyte/Paillier.jl>`_ - Library for Julia, encoding should be compatible.
+- `Javallier <https://github.com/n1analytics/javallier/>`_ - library for Java/Scala. Somewhat
+  different Encoding scheme. Base of 2 is fixed (see :ref:`alternative-base`).
+- `paillier.js <https://github.com/hardbyte/paillier.js>`_ - Early prototype library for Javascript/Typescript.
 
 
 .. toctree::

phe/__about__.py

@@ -7,13 +7,12 @@
 
 __title__ = "phe"
 __summary__ = "Partially Homomorphic Encryption library for Python"
-__uri__ = "https://github.com/n1analytics/python-paillier"
+__uri__ = "https://github.com/data61/python-paillier"
 
 # We use semantic versioning - semver.org
 __version__ = "1.4.1-dev0"
 
-__author__ = "N1 Analytics developers"
-__email__ = "info@n1analytics.com"
-
+__author__ = "CSIRO's Data61"
+__email__ = "confidential-computing@data61.csiro.au"
 __license__ = "GPLv3"
-__copyright__ = "Copyright 2013-2018 {0}".format(__author__)
+__copyright__ = "Copyright 2013-2019 {0}".format(__author__)