Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add some docs for awssum-amazon

  • Loading branch information...
commit 92d701136792dd1d058b6ac319d24d20c40cde82 1 parent 9ae0831
@chilts authored
Showing with 18 additions and 0 deletions.
  1. +18 −0 README.md
View
18 README.md
@@ -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)
Please sign in to comment.
Something went wrong with that request. Please try again.