Merge pull request #326 from diffix/cristian/misc

Misc tweaks.

Author: cristianberneanu

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 0.0.4
+
+  - Minor updates to docs and config terminology.
+
 ## Version 0.0.3
 
 - Tweaked README file for better rendering on PGXN.

META.json

@@ -1,7 +1,8 @@
 {
   "name": "pg_diffix",
   "abstract": "A PostgreSQL extension for strong dynamic anonymization.",
-  "version": "0.0.3",
+  "description": "Diffix is a bundled set of mechanisms for anonymizing structured data. Open Diffix is a project to make Diffix anonymization free and open. More details at open-diffix.org.",
+  "version": "0.0.4",
   "maintainer": "Open Diffix <hello@open-diffix.org>",
   "license": {
     "restricted": "https://github.com/diffix/pg_diffix/blob/master/LICENSE.md"
@@ -12,7 +13,7 @@
         "abstract": "A PostgreSQL extension for strong dynamic anonymization.",
         "file": "src/pg_diffix.c",
         "docfile": "docs/user_guide.md",
-        "version": "0.0.3"
+        "version": "0.0.4"
      }
   },
   "prereqs": {

README.md

@@ -13,24 +13,23 @@ See the [user guide](docs/user_guide.md) for details on configuring and using th
 
 ## Installation
 
-PostgreSQL version 13 or higher is required.
-
-The source is compiled with: `make` or `make TARGET=release` for release version.
-
-You should already have the `postgresql-server-dev-x` package installed if you have postgres version `x`.
+PostgreSQL version 13 or higher is required. You also need `make`, `jq`, and a recent C compiler.
+You should already have the `postgresql-server-dev-x` package installed if you have PostgreSQL version `x`.
 If not, you must install it in order to compile the source.
 
-The compiled extension is installed with: `make install`.
+The source is compiled with: `make` (or `make TARGET=release` for release version).
+The compiled extension is installed with: `make install` (which requires superuser permissions).
 
-You probably need to run it with superuser permission as `sudo make install`.
+The extension is also available on [PGXN](https://pgxn.org/dist/pg_diffix/), and can be installed using
+[PGXN Client](https://pgxn.github.io/pgxnclient/).
 
-In `psql`, you have to install the extension with `CREATE EXTENSION pg_diffix;`.
+When connected to the target database with `psql`, you have to set up the extension with `CREATE EXTENSION pg_diffix;`.
 
 ## Using the extension
 
 Load the extension with `LOAD 'pg_diffix';`, unless you configured it to preload using [these instructions](#preloading-the-extension).
 
-Once installed, the extension logs information to `/var/log/postgresql/postgresql-13-main.log` or equivalent.
+Once loaded, the extension logs information to `/var/log/postgresql/postgresql-13-main.log` or equivalent.
 
 Node dumps can be formatted to readable form by using `pg_node_formatter`.