Skip to content

Commit

Permalink
license, documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Patrick Crosby committed Dec 18, 2011
1 parent 7638410 commit 03cc23a
Show file tree
Hide file tree
Showing 4 changed files with 72 additions and 0 deletions.
19 changes: 19 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (C) 2011 Numerotron Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
Empty file removed README
Empty file.
45 changes: 45 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
amzses
======

This is a Go package to send emails using Amazon's Simple Email Service.

Installation
------------

Use `goinstall`:

goinstall github.com/stathat/amzses

If you are building your code with `goinstall`, you can skip the previous step and just
import `amzses` as follows:

import (
"github.com/stathat/amzses"
)

Using `goinstall` will automatically install its one external dependency,
[jconfig](http://www.stathat.com/src/jconfig).

Usage
-----

Examples available at [www.stathat.com/src/amzses](http://www.stathat.com/src/amzses).

Status
------

This package was extracted from production code powering [StatHat](http://www.stathat.com),
so clearly we feel that it is production-ready, but it should still be considered
experimental as other uses of it could reveal issues we aren't experiencing.

We only implemented the parts of the API that we are using, so this only sends text emails.

Contact us
----------

We'd love to hear from you if you are using `amzses`! We're on twitter: [@stat_hat](http://twitter.com/stat_hat) or [contact us here](http://www.stathat.com/docs/contact).

About
-----

Written by Patrick Crosby at [StatHat](http://www.stathat.com). Twitter: [@stat_hat](http://twitter.com/stat_hat)
8 changes: 8 additions & 0 deletions amzses.go
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
// Copyright 2011 Numrotron Inc.
// Use of this source code is governed by an MIT-style license
// that can be found in the LICENSE file.
//
// Developed at www.stathat.com by Patrick Crosby
// Contact us on twitter with any questions: twitter.com/stat_hat

// amzses is a Go package to send emails using Amazon's Simple Email Service.
package amzses

import (
Expand Down

0 comments on commit 03cc23a

Please sign in to comment.