X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=email-validator.cabal;h=d86f246945edec2a99e4655001c51ce44ee68cb0;hb=eae92cebe7fab4afc5c7de377ec30ec348ef09ad;hp=88700645102ea45d113f40d169d2eefa36c71543;hpb=d9cf306292f2bfaa00b4773737b67de7f4ecf983;p=email-validator.git

diff --git a/email-validator.cabal b/email-validator.cabal
index 8870064..d86f246 100644
--- a/email-validator.cabal
+++ b/email-validator.cabal
@@ -1,5 +1,5 @@
 name:           email-validator
-version:        0.0.1
+version:        0.0.2
 cabal-version:  >= 1.8
 author:         Michael Orlitzky
 maintainer:	Michael Orlitzky <michael@orlitzky.com>
@@ -12,7 +12,38 @@ extra-source-files:
 synopsis:
   Perform basic syntax and deliverability checks on email addresses.
 description:
-  Perform basic syntax and deliverability checks on email addresses.
+  Validate an email address using three techniques:
+  .
+    * Ensuring that the length of local and domain parts is within the
+      RFC-specified limits.
+  .
+    * A syntax check using a regular expression, or the full RFC 5322
+      grammar (see the @--rfc5322@ option).
+  .
+    * Confirmation of the existence of an @MX@ record for the domain part of
+      the address. This is not required; in fact many domains accept mail
+      via an @A@ record for e.g. example.com which is used in lieu of an @MX@
+      record. This behavior can be controlled via the @--accept-a@ flag.
+  .
+  These checks are performed in parallel using the number of available
+  threads. To increase the number of threads, you can pass the
+  appropriate flag to the GHC runtime.
+  .
+  This will set the number of threads to 25:
+  .
+  @
+  $ email-validator -i addresses.csv +RTS -N25
+  @
+  .
+  /Input/
+  .
+  The @input@ file (default: stdin) should be a list of email addresses,
+  one per line. Empty lines will be ignored.
+  .
+  /Output/
+  .
+  Valid email addresses will be written to the output file (default:
+  stdout), one per line.
 
 
 executable email-validator
@@ -21,14 +52,13 @@ executable email-validator
     bytestring                  == 0.10.*,
     cmdargs                     == 0.10.*,
     directory                   == 1.2.*,
-    dns                         == 0.3.*,
+    dns                         == 1.*,
     email-validate              == 1.*,
     HUnit                       == 1.2.*,
     parallel-io                 == 0.3.*,
     pcre-light                  >= 0.4,
     test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    utf8-string                 == 0.3.*
+    test-framework-hunit        == 0.3.*
 
   main-is:
     Main.hs
@@ -73,14 +103,13 @@ test-suite testsuite
     bytestring                  == 0.10.*,
     cmdargs                     == 0.10.*,
     directory                   == 1.2.*,
-    dns                         == 0.3.*,
+    dns                         == 1.*,
     email-validate              == 1.*,
     HUnit                       == 1.2.*,
     parallel-io                 == 0.3.*,
     pcre-light                  >= 0.4,
     test-framework              == 0.8.*,
-    test-framework-hunit        == 0.3.*,
-    utf8-string                 == 0.3.*
+    test-framework-hunit        == 0.3.*
 
   -- It's not entirely clear to me why I have to reproduce all of this.
   ghc-options: