Skip to content

Commit 49f3da3

Browse files
committed
update README formatting. Fix minor typos
1 parent 53f1284 commit 49f3da3

File tree

1 file changed

+42
-40
lines changed

1 file changed

+42
-40
lines changed

README.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
![Pure](http://f.cl.ly/items/281x142x250t0W3g1H14/pure.jpg)
2-
31
Pure
42
====
53

4+
![Pure](http://f.cl.ly/items/281x142x250t0W3g1H14/pure.jpg)
5+
66
A set of small, responsive CSS modules that you can use in every web project.
77

8-
Homepage: [http://www.purecss.io](http://www.purecss.io)
9-
Get it from CDN:
8+
**Homepage:** [http://purecss.io](http://purecss.io)
9+
10+
**Get it from CDN:**
1011

1112
```html
1213
<link rel="stylesheet" href="http://yui.yahooapis.com/pure/0.0.2/pure-min.css">
@@ -18,22 +19,31 @@ Get it from CDN:
1819
Pure is meant to be a starting point for every website or web app. We take care of all the CSS work that
1920
every site needs, without making it look cookie-cutter:
2021

21-
* A responsive grid that can be customized to your needs
22+
* A responsive grid that can be customized to your needs.
23+
2224
* A solid base built on [normalize.css](http://necolas.github.io/normalize.css/) to fix cross-browser compatibility issues.
23-
* Consistently styled buttons
24-
* Styles for vertical and horizontal menus
25-
* Useful form alignments
26-
* Various common table styles
27-
* An extremely minimalist look that is super-easy to customize
28-
* Responsive by default, with a non-responsive option
25+
26+
* Consistently styled buttons that work with `<a>` and `<button>` elements.
27+
28+
* Styles for vertical and horizontal menus, including support for dropdown menus.
29+
30+
* Useful form alignments that look great on all screen sizes.
31+
32+
* Various common table styles.
33+
34+
* An extremely minimalist look that is super-easy to customize.
35+
36+
* Responsive by default, with a non-responsive option.
37+
2938
* Easy one-click customization with the [Skin Builder](http://yui.github.io/skinbuilder/?mode=pure)
30-
* Extremely small file size: ***< 5KB!***
3139

32-
[Check out Pure](http://www.purecss.io)
40+
* Extremely small file size: *** 4.8KB minified + gzip***
41+
42+
[Check out Pure](http://purecss.io)
3343

3444
## Get Started
3545

36-
To get started using Pure, go to the [Pure CSS website](http://www.purecss.io). The website has extensive documentation and examples necessary to get you started using Pure.
46+
To get started using Pure, go to the [Pure CSS website](http://purecss.io). The website has extensive documentation and examples necessary to get you started using Pure.
3747

3848
You can include the Pure CSS file in your project by fetching it from Yahoo's CDN:
3949

@@ -46,49 +56,41 @@ You can include the Pure CSS file in your project by fetching it from Yahoo's CD
4656
Optionally, you can build Pure from it's source on Github. To do this, you'll need to have NodeJS and npm installed. We use Grunt to build Pure.
4757

4858
```shell
49-
git clone git@github.com:yui/pure.git
50-
cd pure
51-
npm install
52-
grunt
59+
$ git clone git@github.com:yui/pure.git
60+
$ cd pure
61+
$ npm install
62+
$ grunt
5363
```
5464

55-
Now, all Pure CSS files should be built into the `pure/build/` directory. All files that are in this build directory are also available on the CDN. The naming conventions of the built files follow these rules:
65+
Now, all Pure CSS files should be built into the `pure/build/` directory. All files that are in this build directory are also available on the CDN. The naming conventions of the files in the `build/` directory follow these rules:
66+
67+
* `build/[module]-nr.css`: Rollup of `src/[module]-core.css` + `src/[module].css` + `src/[module]-[feature].css`. This is the non-responsive version of a module.
68+
69+
* `build/[module].css`: Rollup of `build/[module]-nr.css` + `src/[module]-r.css`. This is the responsive version of a module.
70+
71+
* `build/*-min.css`: A minified file version of the files of the same name.
5672

57-
* `[module]-nr.css`: Rollup of `-core.css` + `[module].css` + `-[feature].css`. This is the non-responsive version of a module.
58-
* `[module].css`: Rollup of `-nr.css` + `-r.css`. This is the responsive version of a module.
59-
* `*-min.css`: A minified file version of the files of the same name.
60-
* `kimono-min.css`: A rollup of all `[module].css` files. This is a responsive roll-up of everything.
61-
* `kimono-nr-min.css`: A Rollup of all modules without @media queries. This is a non-responsive roll-up of everything.
73+
* `build/pure-min.css`: A rollup of all `build/[module].css` files. This is a responsive roll-up of everything.
74+
75+
* `build/pure-nr-min.css`: A Rollup of all modules without @media queries. This is a non-responsive roll-up of everything.
6276

6377
### Building specific modules
6478

6579
You can build a specific module by passing in its name into Grunt:
6680

6781
```shell
68-
grunt grids
82+
$ grunt grids
6983
```
7084

7185
## Contributions and Code Standards
7286

73-
Feel free to file bugs and submit pull requests on Github! When submitting a pull request, please checkout a new branch. Don't submit pull requests from your `master` branch. To do this:
74-
75-
```shell
76-
git checkout -b my-pull-request
77-
git add .
78-
git commit -m 'done all my commits'
79-
git push origin my-pull-request
80-
```
81-
82-
Submit a pull request from your `origin/my-pull-request` branch to `pure/master`.
87+
Feel free to file bugs and submit pull requests on Github! When submitting a pull request, please checkout a new feature branch, and submit your pull request from it. Please do not submit pull requests from your `master` branch.
8388

8489
### Versioning
8590

8691
Pure adheres to [Semantic Versioning 2.0](http://semver.org/).
8792

8893
## License
8994

90-
Copyright 2013 Yahoo! Inc. All rights reserved. Check the LICENSE.md for more information.
91-
92-
93-
94-
95+
This software is free to use under the Yahoo! Inc. BSD license.
96+
See the [LICENSE file](https://github.com/yui/pure/blob/master/LICENSE.md) for license text and copyright information.

0 commit comments

Comments
 (0)