diff --git a/README.md b/README.md new file mode 100644 index 0000000..8a15fa3 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Julep + +SASS/SCSS mixins for building mobile web applications. + +## Requirements + +* Bourbon (http://bourbon.io) + +## Installation + +* Clone the repository to your stylesheets directory. + +* Add `@import "julep/julep"` to your SASS/SCSS. + +## Usage + +Simply include the appropriate mixin in your stylesheet. E.g. + + header { + @include header($color); + } + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Added some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request