1.0.0

Initial commit
atomicpages · Sep 6, 2016 · 3ef1597 · 3ef1597
1 parent eee6fd0
commit 3ef1597
Show file tree

Hide file tree

Showing 119 changed files with 117 additions and 13,627 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 node_modules/
 bower_components/
 .idea/
+target/
 #.idea/codeStyleSettings.xml
 #.idea/workspace.xml
 # target/

diff --git a/.npmignore b/.npmignore
@@ -0,0 +1,5 @@
+license.txt
+README.md
+target/
+bower_components/
+node_modules/
diff --git a/README.md b/README.md
@@ -1,29 +1,47 @@
-Skeleton Sass
-=============
+Skeleton Sass Demo
+===================
 
-Welcome to the Skeleton Sass website. Feel free to browse the source code of this website to see how it was created. If you find any issues, feel free to [submit a pull request](https://github.com/atomicpages/skeleton-sass/pull/new/gh-pages) with a fix or file an issue!
+Skeleton Sass Demo is a place to outline a sample project using Skeleton Sass 3 and how to accurately decouple existing and new code from the Skeleton Sass 3 core. This can also serve as a good starting point for your next project with Skeleton Sass. Feel free to fork and create demos of your own!
 
-Looking for Skeleton Sass v1 Site? Find it here: http://atomicpages.github.io/skeleton-sass/v1/
+### What you'll need
+* [Node](https://nodejs.org/)
+* [Npm](https://www.npmjs.com/)
+* [Bower](https://www.npmjs.com/package/bower)
 
-### How do I build?
+This demo uses gulp to automate the task of compiling/watching the Sass code. It also handles things like automate sourcemapping in your `skeleton.css` file, separating files into a development and production state, and more.
+
+With node installed simply run the following from command line:
 
 ~~~bash
-npm i && bower i
+cd path/to/demo
+npm install && bower install
 gulp dist
 ~~~
 
-## Changelog
-### 3.0.0
-* Updated/decoupled dependencies
-* Bump to Skeleton Sass 3 (as part of decoupling process)
-* Made it easier for other developers to contribute to the site
-* Enforced coding standards with `.editorconfig`
-* Fixed bower version issues
-* Switched to Gulp
-* Deployment of artifacts in `target` directory
-* All source code can be found in `source`
-    * **Note:** the only exception to this is `index.html` which serves as the entry point to the site.
-* Dropped legacy `X-UA-Compatible` meta tag. [See here for more info](http://stackoverflow.com/questions/6771258/what-does-meta-http-equiv-x-ua-compatible-content-ie-edge-do)
-
-## TODO
-* Update demo
+If you're new to working with node, npm, bower, and gulp, then we'll break it down:
+
+~~~bash
+npm install
+~~~
+
+This command installs all of the dependencies needed to get gulp working correctly.
+
+~~~bash
+bower install
+~~~
+
+This command installs all of our frontend dependencies and allows us to manage these. We can easily add new components into an existing project, uninstall components, and update dated components as well!
+
+~~~bash
+gulp dist
+~~~
+
+This command invokes a gulp task called `dist` which in turn fires up the `sass` compiler. Check out the [npm module page](https://www.npmjs.com/package/gulp) for additional information.
+
+After running the command above, you'll notice a `target` directory was created. This is our production-ready directory. You're ready to create!
+
+### License
+This project is released under the MIT License. Check the `license.txt` file for the full script.
+
+### Contributing
+Found a bug? Have an enhancement? Submit a pull request with your changes and we'll give you come public recognition!
diff --git a/bower.json b/bower.json
@@ -1,6 +1,7 @@
 {
-	"name": "skeleton-sass",
-	"description": "Skeleton Sass is a highly modularized version of Skeleton CSS",
+	"name": "skeleton-sass-demo",
+	"version": "1.0.0",
+	"description": "A Demo and sample use case of Skeleton Sass 3",
 	"main": "index.html",
 	"authors": [
 		"Dennis Thompson"
@@ -12,7 +13,8 @@
 		"skeleton",
 		"css",
 		"frontend",
-		"responsive"
+		"responsive",
+		"demo"
 	],
 	"homepage": "https://github.com/atomicpages/skeleton-sass",
 	"private": true,
@@ -23,14 +25,7 @@
 		"test",
 		"tests"
 	],
-	"scripts": {
-		"postinstall": ""
-	},
-	"devDependencies": {
-		"smooth-scroll.js": "latest",
-		"jquery.stellar": "latest",
-		"jquery": "2.*",
-		"font-awesome": "latest",
+	"dependencies": {
 		"skeleton-sass": "3.0.0-dev4"
 	}
 }