From 3ee36f641d5a62ac93aa05c6ffad1f9642d88ed0 Mon Sep 17 00:00:00 2001 From: mrmrs Date: Fri, 17 Oct 2014 15:02:48 -0700 Subject: [PATCH] Removing config for hologram and updating README. --- README.md | 20 +++++++++++++++++++- hologram_config.yml | 25 ------------------------- 2 files changed, 19 insertions(+), 26 deletions(-) delete mode 100644 hologram_config.yml diff --git a/README.md b/README.md index 4513685..35958d7 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,27 @@ Build responsive, performant, and easy to maintain interfaces faster. * It should be easy to change an interface without breaking any existing interfaces * Doing one thing extremely well promotes reusability and reduces repetition +## Features + +* Mobile-first css +* Single-purpose class architecture +* Optimized for maximum gzip compression +* Less than 10kb when minified and gzipped +* Usable across projects +* Currently built on sass. Will eventually move the main build to rework, but will offer ports for less, sass, stylus, and vanilla css. + ## Getting started +The easiest way to use tachyons is to include the minified file in the head. +You can include the latest, minified version of tachyons by including this in the head of your html file +### Include it in a project +``` + +``` + +I will add version controlled cdn hosted options soon. + +### Modify the source Set up the project by cloning the repo, navigating into it, and installing the necessary dependencies by running the following commands: ``` @@ -33,7 +52,6 @@ You can alternatively fork the repo and clone your own version of it. ``` npm start ``` - This will watch the sass directory and do the following on file change: * Compile scss files down to css/tachyons.css and css/tachyons.min.css * Run autoprefixer on css/tachyons.css (this allows you to keep vendor prefixes out of your source files) diff --git a/hologram_config.yml b/hologram_config.yml deleted file mode 100644 index 0a3d4e6..0000000 --- a/hologram_config.yml +++ /dev/null @@ -1,25 +0,0 @@ -# Hologram will run from same directory where this config file resides -# All paths should be relative to there - -# The directory containing the source files to parse recursively -source: ./components - -# The directory that hologram will build to -destination: ./docs - -# The assets needed to build the docs (includes header.html, -# footer.html, etc) -# You may put doc related assets here too: images, css, etc. -documentation_assets: ./doc_assets - -# Any other asset folders that need to be copied to the destination -# folder. Typically this will include the css that you are trying to -# document. May also include additional folders as needed. -#dependencies: -# - ./build - -# Mark which category should be the index page -# Alternatively, you may have an index.md in the documentation assets -# folder instead of specifying this config. -index: navigation -