From 7f27af8d52d8ed03615e23a9db5ff33fc8153729 Mon Sep 17 00:00:00 2001
From: mrmrs <hi@mrmrs.cc>
Date: Thu, 13 Mar 2014 01:36:43 -0700
Subject: [PATCH] Add readme file so people can know wut is up

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..709c330
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+# TACHYONS
+
+A performance-first css framework
+
+Simple modules and components that move faster than the speed of light.
+
+
+## Getting started
+
+Set up the project by cloning the repo, navigating into it, then installing the necessary dependencies by running:
+
+```
+ git clone git@github:mrmrs/tachyons.git yourProject
+ cd yourProject
+ rm -rf .git
+ git init
+ git add remote git@github.com/yourUserName/yourProject.git
+ npm install -g gulp
+ npm install .
+```
+
+### To run the development environment
+
+Once you've run npm install just run this very complicated command in your terminal to start gulp
+
+    gulp
+
+This will watch the sass directory and do the following on file change:
+  • Compile scss files down to css/i.css
+  • Run autoprefixer on css/app.css (this allows you to keep vendor prefixes out of your css)
+  • Run csslint and spit the output to your terminal window where you are running gulp
+  • Run an instance of livereload. With the chrome and safari extensions, you can see
+    changes in the browser without hitting refresh
+
+### To minify assets for production
+
+    gulp production
+
+This will
+  • Compile scss files down to css/i.css
+  • Run autoprefixer on css/app.css (this allows you to keep vendor prefixes out of your css)
+  • Minify all css files and move them to in the ./css
+  • Compress / minify all images in the ./img directory
+  • Compress / minify all svg elements in the ./img/svg/ directory
+