Skip to content

Commit 4512a7d

Browse files
author
Drew Blas
committed
Replaced documentation
1 parent 4991597 commit 4512a7d

File tree

7 files changed

+85
-24
lines changed

7 files changed

+85
-24
lines changed

CHANGELOG

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
head:
2+
- Initial creation that supports:
3+
4+
* addresses.list
5+
* addresses.verify(email)
6+
* addresses.delete(email)

LICENSE

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
2+
Copyright (c) 2011 Drew V. Blas <[email protected]>
3+
Copyright (c) 2006-2009 Marcel Molina Jr. <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy of
6+
this software and associated documentation files (the "Software"), to deal in the
7+
Software without restriction, including without limitation the rights to use,
8+
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
9+
Software, and to permit persons to whom the Software is furnished to do so,
10+
subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
19+
AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

LICENSE.txt

Lines changed: 0 additions & 20 deletions
This file was deleted.

README

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
= AWS::SES
2+
3+
AWS::SES is a Ruby library for Amazon's Simple Email Service's REST API (http://aws.amazon.com/ses).
4+
5+
== Getting started
6+
7+
To get started you need to require 'aws/ses':
8+
9+
% irb -rubygems
10+
irb(main):001:0> require 'aws/ses'
11+
# => true
12+
13+
Before you can do anything, you must establish a connection using Base.new. A basic connection would look something like this:
14+
15+
ses = AWS::SES::Base.new(
16+
:access_key_id => 'abc',
17+
:secret_access_key => '123'
18+
)
19+
20+
The minimum connection options that you must specify are your access key id and your secret access key.
21+
22+
23+
= Addresses
24+
25+
AWS::SES::Addresses provides for:
26+
* Listing verified e-mail addresses
27+
* Adding new e-mail addresses to verify
28+
* Deleting verified e-mail addresses
29+
30+
31+
== Contributing to aws-ses
32+
33+
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
34+
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
35+
* Fork the project
36+
* Start a feature/bugfix branch
37+
* Commit and push until you are happy with your contribution
38+
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
39+
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
40+
41+
== Copyright
42+
43+
Copyright (c) 2011 Drew Blas. See LICENSE for further details.
44+
45+
== Thanks
46+
47+
Special thanks to Marcel Molina Jr. for his creation of AWS::S3 which I used portions of to get things working.

README.rdoc renamed to README.erb

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
= aws-ses
1+
= AWS::SES
22

3-
Description goes here.
3+
<%= docs_for['AWS::SES'] %>
4+
5+
= Addresses
6+
7+
<%= docs_for['AWS::SES::Addresses'] %>
48

59
== Contributing to aws-ses
610

@@ -14,6 +18,8 @@ Description goes here.
1418

1519
== Copyright
1620

17-
Copyright (c) 2011 Drew Blas. See LICENSE.txt for
18-
further details.
21+
Copyright (c) 2011 Drew Blas. See LICENSE for further details.
22+
23+
== Thanks
1924

25+
Special thanks to Marcel Molina Jr. for his creation of AWS::S3 which I used portions of to get things working.

TODO

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* Implement the rest of the API
2+
* Use a better XML parser (and be consistent)

lib/aws-ses.rb

Whitespace-only changes.

0 commit comments

Comments
 (0)