Skip to content

Commit

Permalink
make README a bit more 👌
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisburnell committed Aug 25, 2020
1 parent a57cd76 commit be9039d
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ This has a positive effect that ranges from giving the colours in your design sy
- **With npm:** `npm install @chrisburnell/bowhead`
- **Direct download:** [https://github.com/chrisburnell/bowhead/archive/master.zip](https://github.com/chrisburnell/bowhead/archive/master.zip)

Then you’ll have to include it in your SCSS somehow. You could use Webpack or if you’re using *npm* something like this would suffice:

```scss
@import "node_modules/@chrisburnell/bowhead/bowhead";
```

## Usage

There are three main moving parts to this set-up:
Expand Down Expand Up @@ -55,7 +61,7 @@ $bowhead-tokens: (

`$bowhead-show-fallback` is either `true` *(default)* or `false` and determines whether or not **Bowhead** should print fallback values for browsers that do not support CSS Variables.

**`true`:**
**`$bowhead-show-fallback: true;`**

```css
body {
Expand All @@ -64,7 +70,7 @@ body {
}
```

**`false`:**
**`$bowhead-show-fallback: false;`**

```css
body {
Expand Down Expand Up @@ -104,6 +110,8 @@ body {
}
```

will generate…

```css
body {
background-color: #d2b48c;
Expand Down

0 comments on commit be9039d

Please sign in to comment.