OpenSSL::Query: Add a start of documentation

diff --git a/MANIFEST b/MANIFEST
index d1bc32653533c06b51f693ddc64d2230afda06a4..fec46d4d2891fbe3d5002320f1d40632bbe76cc3 100644 (file)
--- a/MANIFEST
+++ b/MANIFEST
@@ -5,5 +5,6 @@ lib/OpenSSL/Query/ClaREST.pm
 Makefile.PL
 MANIFEST
 META.yml
+README.md
 t/query.t
 t/00-load.t

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..8b63241
--- /dev/null
+++ b/README.md
@@ -0,0 +1,48 @@
+OpenSSL::Query
+==============
+
+A module to query certain information about OpenSSL committers as well
+as members of the OMC (OpenSSL Management Committee).  These data are
+usually interesting for other programs that need to verify identities,
+whether a certain person holds a CLA, that sort of thing.
+
+OpenSSL::Query is built to be able to handle several implementations
+for access to the databases that hold the data.  The default
+implementation uses a RESTful API with JSON encoded responses.
+
+Requirements
+------------
+
+OpenSSL::Query requires the following modules to build:
+
+- Module::Starter and its dependencies (debian package libmodule-starter-perl)
+
+OpenSSL::Query requires these extra modules to run:
+
+- Class::Method::Modifiers     (debian package libclass-method-modifiers-perl)
+- Moo                          (debian package libmoo-perl)
+- URI::Encode                  (debian package liburi-encode-perl)
+
+Any other module OpenSSL::Query depends on should be part of core
+perl.
+
+Installation
+------------
+
+    $ perl Makefile.PL
+    $ make
+    $ make install
+
+Testing
+-------
+
+Testing is done like this:
+
+    $ make test
+
+However, it requires that a temporary query service is started as
+well.  This is part of QueryApp, and is started like this:
+
+    $ cd ../QueryApp   # Or wherever you have it checked out
+    $ PERSONDB=./t/query_data/pdb.yaml CLADB=./t/query_data/cdb.txt \
+      PERL5LIB=./lib:../OpenSSLQuery/lib plackup bin/query.psgi