Adding a README.

This commit is contained in:
Matt Swensen 2016-12-17 21:46:09 -07:00
parent 54137186d9
commit 31ffb6f65a

15
README.md Normal file

@ -0,0 +1,15 @@
An [iTerm](https://www.iterm2.com/) theme generator for [themer](https://github.com/mjswensen/themer).
## Installation & usage
Install this module wherever you have `themer` installed.
yarn add themer-iterm
Then pass `themer-iterm` as a `-t` (`--template`) argument to `themer`:
themer -c my-colors.js -t themer-iterm -o gen/
`themer-iterm` will generate a `themer-iterm-dark.itermcolors` or `themer-iterm-light.itermcolors` (or both), depending on which color set you passed to `themer`.
To install your theme, press `cmd`-`i` to open the iTerm preferences, then choose Colors > Color Presets... > Import... and choose the generated files.