Skip to content
This repository has been archived by the owner on Jun 5, 2018. It is now read-only.

Commit

Permalink
Add some docs for awssum-amazon
Browse files Browse the repository at this point in the history
  • Loading branch information
chilts committed Mar 18, 2013
1 parent 9ae0831 commit 92d7011
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Amazon (for AwsSum) #

This is the base class for all Amazon services. It defines a few things such as constants and the constructor expects
certain variables to be passed in, which are common across (most) services.

It also defines two other base classes which include signing for AWS Signature v2 and AWS Signature v4. Your base class
can inherit from these rather than the plain base class.

## Writing an Amazon Service plugin for AwsSum ##

There are many examples of service plugins for Amazon, so please take a look at the following repos:

* https://github.com/awssum/awssum-amazon-s3 (custom signature)
* https://github.com/awssum/awssum-amazon-ec2 (AWS Signature v2)
* https://github.com/awssum/awssum-amazon-ses (custom signature)
* https://github.com/awssum/awssum-amazon-dynamodb (AWS Signature v4)

(Ends)

0 comments on commit 92d7011

Please sign in to comment.