Skip to content

Commit

Permalink
Update Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmrs committed Aug 24, 2016
1 parent 4f3c819 commit 68757cc
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# tachyons-borders 2.2.0
# tachyons-borders 2.2.4

Performance-first css module for styling borders.

Expand All @@ -16,12 +16,22 @@ bytes | selectors | declarations
npm install --save-dev tachyons-borders
```

Learn more about using css installed with npm:
* https://webpack.github.io/docs/stylesheets.html
* https://github.com/defunctzombie/npm-css

#### With Git

http:
```
git clone https://github.com/tachyons-css/tachyons-borders
```

ssh:
```
git clone [email protected]:tachyons-css/tachyons-borders.git
```

## Usage

#### Using with [PostCSS](https://github.com/postcss/postcss)
Expand All @@ -36,11 +46,19 @@ Then process the CSS using the [`tachyons-cli`](https://github.com/tachyons-css/

```sh
$ npm i -g tachyons-cli
$ tachyons-cli path/to/css-file.css > dist/t.css
$ tachyons path/to/css-file.css > dist/t.css
```

#### Using the CSS

##### CDN
The easiest and most simple way to use the css is to use the cdn hosted version. Include it in the head of your html with:

```
<link rel="stylesheet" href="http://npmcdn.com/[email protected]/css/tachyons-borders.min.css" />
```

##### Locally
The built CSS is located in the `css` directory. It contains an unminified and minified version.
You can either cut and paste that css or link to it directly in your html.

Expand Down Expand Up @@ -116,5 +134,5 @@ Running `$ npm start` will process the source CSS and place the built CSS in the

## License

MIT
ISC

0 comments on commit 68757cc

Please sign in to comment.