Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmrs committed Sep 24, 2018
1 parent bef7461 commit eafaa77
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# tachyons-borders 3.0.0
# tachyons-borders 3.0.5

Performance-first css module for styling borders.

#### Stats
### Stats

308 | 24 | 48
---|---|---
Expand Down Expand Up @@ -34,32 +34,32 @@ git clone [email protected]:tachyons-css/tachyons-borders.git

## Usage

#### Using with [PostCSS](https://github.com/postcss/postcss)
#### Using with [Postcss](https://github.com/postcss/postcss)

Import the css module

```css
@import "tachyons-borders";
```

Then process the CSS using the [`tachyons-cli`](https://github.com/tachyons-css/tachyons-cli)
Then process the css using the [`tachyons-cli`](https://github.com/tachyons-css/tachyons-cli)

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

#### Using the 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].0/css/tachyons-borders.min.css" />
<link rel="stylesheet" href="http://unpkg.com/[email protected].5/css/tachyons-borders.min.css" />
```

##### Locally
The built CSS is located in the `css` directory. It contains an unminified and minified version.
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.

```html
Expand All @@ -68,10 +68,10 @@ You can either cut and paste that css or link to it directly in your html.

#### Development

The source CSS files can be found in the `src` directory.
Running `$ npm start` will process the source CSS and place the built CSS in the `css` directory.
The source css files can be found in the `src` directory.
Running `$ npm start` will process the source css and place the built css in the `css` directory.

## The CSS
## The css

```css
/*
Expand Down

0 comments on commit eafaa77

Please sign in to comment.