V4

* Scratch

* init commit

* added docs

.gitignore

@@ -1 +1,2 @@
-.DS_Store
+.DS_Store
+node_modules

README.md

@@ -1,37 +1,50 @@
-West
-====
+# West
+West is a minimal and simplistic responsive slide-out navigation.
 
-West is a slide-in navigation with gesture support on mobile & tablet. It is also browser compatible and is incredibly lightweight and easy to install. View it live [here](http://dope.github.io/west)
+## Installation
+```git clone http://github.com/dope/west```
 
-# Installation
-The installation is not hard, if you literally have basic HTML & CSS knowledge, you will be fine. First you need to download the [master](https://github.com/dope/west/archive/master.zip) and link your stylesheets and scripts.
+```bower install west```
 
-```
-<link rel="stylesheet" type="text/css" href="css/west.css">
-<script src="js/west.js" type="text/javascript"></script>
-```
+Or download the master.zip [here](https://github.com/dope/west/archive/master.zip)
+
+## Setup
+
+Firstly add the assets to your HTML file.
+
+```<link rel="stylesheet" href="../src/dist/west.min.css">```
+
+```<script src="../src/dist/west.min.js"></script>```
+
+Next you will need to add your HTML
 
-In order for this to work, you'll need to link jQuery — You can either do this by downloading the library from the [jQuery](http://jquery.com) website or link them direct:
 ```
-<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.10.2/jquery.min.js"></script>
+<aside class="west">
+    <div class="west__trigger">Menu</div>
+    <nav class="west__menu">
+        <h2>Albums</h2>
+        <ul class="west__wrapper">
+            <li class="west__list"><a href="#" class="west__link">Item</a></li>
+        </ul>
+    </nav>
+</aside>
 ```
 
-Once your scripts are set up, you need to create your ```html``` document.
+## Support
+If you have any questions feel free to tweet me [@joericho](http://twitter.com/joericho) and I'll reply as soon as I can.
+
+If you find any bugs, issues etc please feel to open an issue [here](https://github.com/dope/west/issues/new)
+
+
+## License
 
-Next is the actual navigation itself.
-```
-<nav class="site-menu js-menu">
-    <span class="site-menu__trigger js-trigger"></span>
-    <ul class="site-menu__nav">
-        <li class="site-menu__list"><a href="#" class="site-menu__link">List Item</a></li>
-        <li class="site-menu__list"><a href="#" class="site-menu__link">List Item</a></li>
-        <li class="site-menu__list"><a href="#" class="site-menu__link">List Item</a></li>
-        <li class="site-menu__list"><a href="#" class="site-menu__link">List Item</a></li>
-        <li class="site-menu__list"><a href="http://github.com/dope/west" class="site-menu__link">GitHub Project</a></li>
-        <li class="site-menu__list"><a href="http://twitter.com/joericho" class="site-menu__link">@joericho</a></li>
-    </ul>
-</nav>
 ```
+The MIT License (MIT)
+Copyright (c) 2016 Joe Richardson
 
-# That's it.
-It's that simple, if you have any issues or questions: [tweet me](http://twitter.com/joericho)
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```

bower.json

@@ -0,0 +1,24 @@
+{
+  "name": "West",
+  "description": "Slide out navigation",
+  "main": "west.js",
+  "authors": [
+    "Joe Richardson <[email protected]>"
+  ],
+  "license": "MIT",
+  "keywords": [
+    "html5",
+    "ui",
+    "javascript",
+    "scss",
+    "sass"
+  ],
+  "homepage": "https://github.com/dope/west",
+  "ignore": [
+    "**/.*",
+    "node_modules",
+    "bower_components",
+    "test",
+    "tests"
+  ]
+}

gulpfile.js

@@ -0,0 +1,38 @@
+var gulp   = require('gulp');
+var sass   = require('gulp-sass');
+var uglify = require('gulp-uglify');
+var prefix = require('gulp-autoprefixer');
+var rename = require('gulp-rename');
+
+gulp.task('sass', function() {
+    gulp.src('src/west.scss')
+    .pipe(sass())
+    .on('error', sass.logError)
+    .pipe(prefix('last 2 versions', '> 1%', 'ie 8', 'Android 2', 'Firefox ESR'))
+    .pipe(gulp.dest('src/dist'))
+    gulp.src('src/west.scss')
+    .pipe(sass({outputStyle: 'compressed'}))
+    .pipe(rename({
+        suffix: '.min'
+    }))
+    .pipe(gulp.dest('src/dist'))
+});
+
+gulp.task('scripts', function() {
+    gulp.src('src/west.js')
+    .pipe(uglify())
+    .pipe(rename({
+        suffix: '.min'
+    }))
+    .pipe(gulp.dest('src/dist'))
+});
+
+/* Build Assets */
+gulp.task('default', ['sass', 'scripts']);
+
+
+/* Watch Assets */
+gulp.task('watch', ['sass'], function () {
+    gulp.watch("src/*.scss", ['sass']);
+    gulp.watch("src/*.js", ['scripts']);
+});

package.json

@@ -0,0 +1,24 @@
+{
+  "name": "West",
+  "version": "4.0.0",
+  "description": "Slide out navigation",
+  "main": "west.js",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/dope/west.git"
+  },
+  "author": "Joe Richardson <[email protected]>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dope/west/issues"
+  },
+  "homepage": "https://dope.github.io/west",
+  "dependencies": {
+    "gulp": "^3.9.1",
+    "gulp-autoprefixer": "^3.1.0",
+    "gulp-minify": "0.0.11",
+    "gulp-rename": "^1.2.2",
+    "gulp-sass": "^2.3.1",
+    "gulp-uglify": "^1.5.3"
+  }
+}