README.rdoc in spf-0.0.41 vs README.rdoc in spf-0.0.42
- old
+ new
@@ -1,12 +1,32 @@
= SPF
The +spf+ Ruby gem, also known as +spf-ruby+, is an implementation of the Sender Policy Framework (SPF) e-mail sender
-authentication system.
+authentication system. It is closely based on the Mail::SPF Perl library at <http://search.cpan.org/~jmehnle/Mail-SPF-v2.005/>, so most of Mail::SPF's documentation is applicable.
See <http://www.openspf.org> for more information about SPF.
Note: This gem is currently very early in its lifecycle. The API is *not* guaranteed to be stable.
+
+== Usage
+
+ require 'spf'
+
+ spf_server = SPF::Server.new
+
+ request = SPF::Request.new(
+ versions: [1, 2], # optional
+ scope: 'mfrom', # or 'helo', 'pra'
+ identity: 'fred@example.com',
+ ip_address: '192.168.0.1',
+ helo_identity: 'mta.example.com' # optional
+ )
+
+ result = spf_server.process(request)
+
+ puts result
+
+ result_code = result.code # :pass, :fail, etc.
== Copyright
Copyright 2013, 2014 Agari Data, Inc.