Documentation updates for 1.0.0 release

CHANGES

@@ -1,3 +1,6 @@
+1.0.0 2018-05-11
+ - Minor documentation updates
+
 0.9.7 2018-03-19
  - Made sysv init executable
  - Add missing documentation key to system/dkimpy-milter.service

README

@@ -1,6 +1,5 @@
-This is a DKIM signing and verification milter.  In theory it works with both
+This is a DKIM signing and verification milter.  In theory it has been tested
-Postfix and Sendmail, but the author has zero experience with Sendmail, so
+with both Postfix and Sendmail.
-reports of success/failure with Sendmail and patches are welcom.
 
 The configuration file is designed to be compatible with OpenDKIM, but only
 a subset of OpenDKIM options are supported.  If an unsupported option is
@@ -25,7 +24,10 @@ packages are not available):
 [sudo] pip install dkimpy_milter
 
 Using pip will cause required packages to be installed via easy_install if they
-have not been previously installed.
+have not been previously installed.  Because pymilter and PyNaCl are compiled
+Python extensions, the system will need appropriate development packages and
+an C compiler.  Alternately, install these dependencies from dsitribution/OS
+packages and then pip install dkimpy_milter.
 
 The milter will work with either pydns (DNS) or dnspython (dns), preferring
 dnspython is both are available.  The dkimpy DKIM module also works with
@@ -126,10 +128,13 @@ MacroListVerify		daemon_name|VERIFYING
 
 
 The python DKIM library, dkimpy, requires the entire message being signed or
-verified to be in memory, so dkimpy-milter does not write messages out to a temp
+verified to be in memory, so dkimpy-milter does not write messages out to a
-file.  This may impact performance on low-memory systems.
+temp file.  This may impact performance on low-memory systems.
 
-This is an beta grade release to support interoperability testing with Ed25519
+This is an initial production release to support interoperability testing with
-signatures sufficient functionality for basic use.  The documented
+Ed25519 signatures sufficient functionality for basic use.  The documented
-functionality has been implemented and at least partially tested.  It is free
+functionality has been implemented and at generally partially tested.  It is
-of known major defects, but is not fully tested in a variety of environments.
+free of known defects, but is not fully tested in a variety of environments.
+
+DKIM Ed25519 signatures are still in development, but the specification is
+technically stable.  Version 1.0.0 supports draft-ietf-dcrup-dkim-crypto-09.

dkimpy_milter/__init__.py

@@ -39,7 +39,7 @@ from dkimpy_milter.util import read_keyfile
 from dkimpy_milter.util import own_socketfile
 from dkimpy_milter.util import fold
 
-__version__ = "0.9.7"
+__version__ = "1.0.0"
 FWS = re.compile(r'\r?\n[ \t]+')
 
 

setup.py

@@ -30,14 +30,14 @@ except ImportError:  # If PyDNS is not installed, prefer dnspython
 
 setup(
     name='dkimpy-milter',
-    version='0.9.7',
+    version='1.0.0',
     author='Scott Kitterman',
     author_email='scott@kitterman.com',
     url='https://launchpad.net/dkimpy-milter',
     description=description,
     download_url = "https://pypi.python.org/pypi/dkimpy-milter",
     classifiers= [
-        'Development Status :: 4 - Beta',
+        'Development Status :: 5 - Production/Stable',
         'Environment :: No Input/Output (Daemon)',
         'Intended Audience :: System Administrators',
         'License :: OSI Approved :: GNU General Public License (GPL)',