mshillam
/
responsive-html-email-signature
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

#12 Update docs

This commit is contained in:
Dan Mindru 2016-08-19 19:46:15 +02:00
parent c2bad1843c
commit 6816ef605f
2 changed files with 2 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -29,6 +29,7 @@ See a fairly comprehensive rant on the subject (and not only) [in this article](
- [x] can build templates from multiple sources - [x] can build templates from multiple sources
- [x] watches HTML / CSS files for changes and re-builds - [x] watches HTML / CSS files for changes and re-builds
- [x] supports LESS / SASS / PostCSS - [x] supports LESS / SASS / PostCSS
- [x] autoprefixer, so you don't have to worry about your `-moz-`s or `-webkit-`s
**Some mail clients don't support them, so an external URL might be a good idea. Also, some clients might complain about the size, so keep an eye out.* **Some mail clients don't support them, so an external URL might be a good idea. Also, some clients might complain about the size, so keep an eye out.*
@ -40,6 +41,7 @@ $ gulp # By default, HTML & CSS files in './src' will be watched for changes
``` ```
Take a look at `src/light/` for an example. Copy / Paste, rename it and change `src/light/conf.js` to suite your needs. Run `gulp` to build the templates (into `/dist`). Take a look at `src/light/` for an example. Copy / Paste, rename it and change `src/light/conf.js` to suite your needs. Run `gulp` to build the templates (into `/dist`).
> NB: Stylesheets are included automatically, place them wherever in the directory.
## Template structure (examples) ## Template structure (examples)
There are 2 examples of template structures, one for the `light` email template and one for the `dark` one. There are 2 examples of template structures, one for the `light` email template and one for the `dark` one.

11
TODO.md
View File

@ -1,11 +0,0 @@
#Future release notes & todo
This is a pre-release, stuff will be mostly ready when the items bellow are done. Feel free to contribute!
##Todo
- use fs-extra instead of wrench
- [100⭐️] issues
##Doc updates
- Stylesheets are included automatically, place them wherever in the dir
- Autoprefixer is there to help
- use SASS, LESS or postcss.