[](https://www.npmjs.org/package/foundation-emails)
[](https://www.npmjs.org/package/foundation-emails)
+[](https://badge.fury.io/rb/foundation_emails)
[](https://www.npmjs.org/package/foundation-emails)
-
Foundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client — even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency. And with the [Inky](https://github.com/zurb/inky) templating language, writing HTML emails is now even easier.
## Getting Started
Run `npm run build` to do a full email inlining process.
+
+#### Using the Ruby gem
+
+**foundation_emails** is a gem that enables you to use Foundation for Emails assets within a Rails project. To install in your app:
+
+1. Add the following line to your Gemfile:
+
+ ```ruby
+ gem 'foundation_emails'
+ ```
+
+2. Then execute:
+
+ ```bash
+ bundle install
+ ```
+
+3. Import Foundation for Emails in your `application.scss`:
+
+ ```scss
+ @import "foundation-emails";
+ ```
+
## Documentation
**Check out our [Migration Guide](https://github.com/zurb/foundation-emails/blob/master/migration.md) for upgrading an existing template or for more in-depth code examples.**
-# Foundation for Emails Gem
+# foundation_emails
[](https://badge.fury.io/rb/foundation_emails)
+**foundation_emails** is a gem that enables you to use Foundation for Emails assets within a Rails project.
+
Foundation for Emails (previously known as Ink) is a framework for creating responsive HTML emails that work in any email client — even Outlook. Our HTML/CSS components have been tested across every major email client to ensure consistency.
## Installation
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'foundation_emails'
-```
+1. Add the following line to your Gemfile:
-Or install it yourself as:
+ ```ruby
+ gem 'foundation_emails'
+ ```
- $ gem install foundation_emails
+2. Then execute:
-## Usage
+ ```bash
+ bundle install
+ ```
-To include in your assets, place the following in your desired stylesheets manifest:
+3. Import Foundation for Emails in your `application.scss`:
-```scss
- @import "foundation-emails";
-```
+ ```scss
+ @import "foundation-emails";
+ ```
## License