]> git.ipfire.org Git - thirdparty/foundation/foundation-emails.git/commitdiff
Added README, CONTRIBUTING, and LICENSE.
authorJeanie Chung <jeanie.chung@gmail.com>
Thu, 22 Jan 2015 00:56:51 +0000 (16:56 -0800)
committerJeanie Chung <jeanie.chung@gmail.com>
Thu, 22 Jan 2015 00:56:51 +0000 (16:56 -0800)
CONTRIBUTING.md [new file with mode: 0644]
LICENSE.md [new file with mode: 0644]
README.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644 (file)
index 0000000..7b10963
--- /dev/null
@@ -0,0 +1,11 @@
+# Foundation for Email
+
+## Contributing
+
+1. Fork it.
+2. Create your feature branch (`git checkout -b my-new-feature`).
+3. Test your changes to the best of your ability.  We suggest utilizing the templates by running `grunt make:templates` and testing the compiled versions in the build folder.  It's expecially helpful if you can provide a Litmus test with your pull request.
+4. Update the documentation to reflect your changes if they add or changes current functionality. Run `grunt make:docs` to compile the documentation into the build folder and preview it.
+5. Commit your changes (`git commit -am 'Added some feature'`).
+6. Push to the branch (`git push origin my-new-feature`).
+7. Create a new pull request.
\ No newline at end of file
diff --git a/LICENSE.md b/LICENSE.md
new file mode 100644 (file)
index 0000000..89f0667
--- /dev/null
@@ -0,0 +1,9 @@
+Copyright (c) 2015 ZURB, inc.
+
+MIT License
+
+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.
\ No newline at end of file
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..95ee2cdcb8464771a9333b40423e3181bafe534b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -0,0 +1,35 @@
+Foundation for Email
+===
+
+Foundation for Email is a responsive email framework, used to make HTML emails look great on any client or device.  It includes a 12-column grid, as well as some simple UI elements for rapid prototyping.
+
+Homepage:      TBD<br />
+Documentation: TBD<br />
+Download:      TBD
+
+Foundation for Email is MIT-licensed and absolutely free to use. Foundation for Email wouldn't be possible without the support of the entire ZURB team, our friends and colleagues who gave feedback, and some luminaries who did some heavy lifting that we took advantage of (thanks guys).
+
+Repo Contents
+=============
+
+* SCSS Folder
+* HTML Folder
+* gulp file
+* Responsive Email Templates
+* README, CONTRIBUTING and LICENSE
+
+Installation Instructions
+=============
+
+1. Clone the repo with `git clone git@github.com:zurb/foundation-email.git`.
+2. Navigate into the directory.
+3. Run `npm install`. If you don't have node.js installed, downloaded it at [nodejs.org](http://nodejs.org/download/).
+4. Run `gulp build` to build the initial templates.
+5. Run `gulp` to run the server and watch for changes. The default port is http://localhost:8080.
+
+ZURB
+====
+
+Foundation for Email was made by [ZURB](http://www.zurb.com), a product design company in Campbell, CA.
+
+If Foundation for Email knocks your socks off the way we hope it does and you want more, why not check out [our jobs](http://www.zurb.com/talent)?
\ No newline at end of file