Sha256: f2b3f1df2667d28f0b5941e10767d92ee2dfa90cecdcb4109ddfde981df168eb

Contents?: true

Size: 891 Bytes

Versions: 2

Compression:

Stored size: 891 Bytes

Contents

# Mailstro Client for Ruby

TODO: Write a gem description

## Installation

1.  Add the `mailstro` gem to your `Gemfile`

    ```ruby
    gem "mailstro"
    ```

2.  Install the gem

    ```shell
    bundle install
    ```

3.  Configure the mailstro module with your API key.

    In rails apps, put this code to a new file at `config/initializers/mailstro.rb`

    ```ruby
    require 'mailstro'

    Mailstro.configure do |config|
      config.api_key = "YOUR_API_KEY_HERE"
    end
    ```

## Usage

To send an email with the template name `welcome` use the following:

```ruby
Mailstro.deliver(:welcome, "test@example.com", :greeting => "Hi")
```

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
mailstro-0.0.4 Readme.md
mailstro-0.0.3 Readme.md