Skip to content

Commit 27628be

Browse files
committed
Rewrite README
1 parent 8674870 commit 27628be

1 file changed

Lines changed: 13 additions & 26 deletions

File tree

README.md

Lines changed: 13 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,22 @@
11
# [barebones](http://barebones.io)
22

3-
[![Build status](https://travis-ci.org/nothingrandom/barebones.svg?branch=master)](https://travis-ci.org/nothingrandom/barebones)
4-
[![devDependency Status](https://david-dm.org/nothingrandom/barebones/dev-status.svg)](https://david-dm.org/nothingrandom/barebones#info=devDependencies)
5-
[![Built with gulp](http://nothingrandom.com/images/built-gulp.svg)](http://gulpjs.com/)
3+
Barebones is the starting point for stylesheets.
64

7-
**A lightweight starting point for web projects**
5+
### What you get
6+
In this project you'll find a great starting point for writing clean, functional stylesheets using scss.
87

9-
Barebones is an advanced and powerful project wireframe. It's build by front end developers for front end developers. It's designed to help speed up your development process, doing the heavy lifting while you can stick to creating new sites.
8+
I've been working on this project since 2012, so it's had a lot of trail, error, and experimentation go into it.
109

11-
----------
10+
The primary source of magic is in the `utilities` file, so I recommend you have a look through.
11+
12+
### Wishlist (and issues)
13+
Any features you'd like to see? Any features don't work for you? Let me know with the issue tracker.
14+
15+
### Recommendations
16+
I suggest that you use this project alongside of [blendid](https://github.com/vigetlabs/blendid). Older users of barebones will remember that it once came with a full gulp setup. I was struggling to keep up with best practices and new tools, and found myself using Vue / React Starter where there was too much bulk here.
1217

13-
## Quick Start
14-
1. Clone the repo _or_ [download the latest release](https://github.com/nothingrandom/barebones/archive/master.zip)
15-
2. Run `npm install` to install the devDependencies
16-
3. Compile your code with `gulp`
17-
18-
## What's included
19-
- Advanced gulpfile
20-
- Compile scss/sass to css
21-
- Compile multiple JS files with browserify
22-
- Image minification
23-
- Build and deploy for release
24-
- Notifications on Mac
25-
- SCSS structure
26-
- Normalize / Reset CSS
27-
- Advanced mixins
28-
- Javascript
29-
- jQuery using npm and browserify
30-
- Custom modernizer 3.1 build
31-
- [Foundation Grid](http://foundation.zurb.com/docs/components/grid.html)
18+
I also recommend that you use this [scss-lint](https://github.com/nothingrandom/scss-lint-default.yml) config.
3219

3320
----------
3421

35-
###### _Made by [nothingrandom](http://nothingrandom.com) :)_
22+
###### _Made by [Benjamin Hollway](http://nothingrandom.com) :)_

0 commit comments

Comments
 (0)