Skip to content

Commit 058b576

Browse files
committed
various updates to the readme
1 parent 71aff22 commit 058b576

1 file changed

Lines changed: 24 additions & 34 deletions

File tree

README.md

Lines changed: 24 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ A lightweight and somewhat opinionated CSS foundation that is best suited to app
1313
- [What it does](#what-it-does)
1414
- [Evolution](#evolution)
1515
- [Browser support](#browser-support)
16-
- [Publishing](#publishing)
17-
- [The breakdown of step 3](#the-breakdown-of-step-3)
1816
- [Contributing](#contributing)
1917
- [Versioning](#versioning)
2018

@@ -60,7 +58,15 @@ The order at which you import each module is important, to see this order and wh
6058

6159
### Importing without a bundler
6260

63-
CDN version coming soon, [see](https://github.com/chris-pearce/backpack.css/issues/15). In the meantime you can link to the hosted version on [UNPKG](https://unpkg.com) via a `<link>` element in your HTML Head, however, make sure it comes before your project's CSS.
61+
CDN version coming soon, [see](https://github.com/chris-pearce/backpack.css/issues/15). In the meantime you can link to the hosted version on [UNPKG](https://unpkg.com) via a `<link>` element in your HTML Head, however, make sure it comes before your project's CSS, e.g.:
62+
63+
```html
64+
<head>
65+
[…]
66+
<link rel="stylesheet" href="https://unpkg.com/backpack.css">
67+
<link rel="stylesheet" href="[path-to-your-project-css]">
68+
</head>
69+
```
6470

6571
### Overriding
6672

@@ -76,23 +82,26 @@ html {
7682

7783
## Motivation
7884

79-
Nowadays I'm building [React](https://reactjs.org/) applications that have highly componentised User Interfaces (UI) making use of native CSS layout mechanisms such as [Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) and [Grid](https://css-tricks.com/snippets/css/complete-guide-grid/). I'm no longer finding the need for heavy handed CSS frameworks that handle most of my UI concerns, especially layout. Instead I build components with a smidgen of global styles.
85+
Nowadays I'm building [React](https://reactjs.org/) applications that have highly componentised User Interfaces (UI) making use of native CSS layout mechanisms such as [Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) and [Grid](https://css-tricks.com/snippets/css/complete-guide-grid/). I'm no longer finding the need for heavy handed CSS frameworks that handle most of my UI concerns, especially layout and utilities. Instead I build components with a smidgen of global styles.
8086

81-
What I do need, however, are a bunch of smart and sensible foundational styles suited for applications that I would typically forget project to project—think [Normalize.css](http://necolas.github.io/normalize.css/) and then some. Something that is lightweight, super easy to intergrate, and can easily be overriden or allow for modular use, thus giving birth to backpack.css 🙂.
87+
What I do need, however, are a bunch of smart and sensible foundational styles suited for applications that I would typically forget project to project—think [Normalize.css](http://necolas.github.io/normalize.css/) and then some. Something that is lightweight, super easy to intergrate, and can easily be overriden or allow for modular use, thus giving birth to backpack.css 🙂🎒.
8288

8389
## What it does
8490

85-
- Removes margins, paddings, and borders from all elements except `<input>` so that everything is on an even playing field.
86-
- Applies sensible form element resets and normalisations, e.g.: _remove all user-agent styles from buttons_.
87-
- Makes all images responsive.
91+
- Applies sensible form element resets, normalisations, and fixes, e.g.: _remove all user-agent styles from buttons_.
8892
- Applies sensible interactive styles, e.g.: _avoid 300ms click delay on touch devices_.
8993
- Applies foundational print styles.
90-
- Applies the nicer `border-box` value to all elements.
91-
- Removes list bullets.
94+
- Applies the nicer `border-box` value for the `box-sizing` property to all elements.
9295
- Applies sensible OpenType features, e.g.: _enables lining numerals, tabular numerals, and slashed zero, for table content_.
96+
- Makes all images responsive.
97+
- Removes margins, paddings, and borders from all elements except `<input>` so that everything is on an even playing field.
98+
- Removes list bullets.
99+
- Removes all user-agent styles from heading elements and resets them to have the same styles as the body copy.
93100

94101
_And more…_
95102

103+
All of the CSS is very well documentated if you want to dig deeper.
104+
96105
## Evolution
97106

98107
This is the third CSS framework/library I've created. Looking at each one lets you see how UI development has evolved over the years with each iteration getting smaller and smaller.
@@ -106,39 +115,20 @@ This is the third CSS framework/library I've created. Looking at each one lets y
106115
- Chrome
107116
- Edge
108117
- Firefox
109-
- Internet Explorer 11
110-
- Safari 8+
118+
- Internet Explorer 11 _(partial)_
119+
- Safari 10+
111120
- Opera
112121

113122
Not everything will work in Internet Explorer 11, e.g.: the [`system-ui`](https://caniuse.com/#feat=font-family-system-uiZ) font, however, anything that doesn't work will simply degrade gracefully.
114123

115-
It's recommended to have [Autoprefixer](https://github.com/postcss/autoprefixer) setup as part of your projects build.
116-
117-
## Publishing
118-
119-
Once new changes have been merged do the following:
120-
121-
1. Add all new changes to [`CHANGELOG.md`](CHANGELOG.md) making sure to follow the existing format.
122-
2. Update the version number in [`index.css`](src/index.css).
123-
3. Run: `npm version <update_type> --force` where `<update_type>` is one of the semantic versioning release types: **patch**, **minor**, or **major** (see [versioning](#versioning)).
124-
125-
### The breakdown of step 3
126-
127-
1. Run the `build` script.
128-
2. Add `CHANGELOG.md` and `index.css` modified in **steps 1** and **2** to the version commit.
129-
3. Change the version number in [`package.json`](package.json).
130-
4. Push the new version commit and tag up to the repository.
131-
5. Clean the `lib` directory.
132-
6. Publish the new version to the NPM registry.
133-
134-
_Each step will only run if the one before it passed._
124+
It's recommended to have [Autoprefixer](https://github.com/postcss/autoprefixer) setup as part of your project's build.
135125

136126
## Contributing
137127

138-
_`CONTRIBUTING.MD` coming soon, [see](https://github.com/chris-pearce/backpack.css/issues/10)._
128+
Please see our [contributing guidelines](CONTRIBUTING.md).
139129

140130
## Versioning
141131

142132
backpack.css is maintained under the [Semantic Versioning guidelines](http://semver.org/). We'll do our best to adhere to those guidelines and strive to maintain backwards compatibility.
143133

144-
See the [CHANGELOG](CHANGELOG.md).
134+
See the [change log](CHANGELOG.md).

0 commit comments

Comments
 (0)