Skip to content

Commit

Permalink
Add better setup instuctions
Browse files Browse the repository at this point in the history
  • Loading branch information
ashley-hebler committed Aug 5, 2019
1 parent 22311da commit 79af158
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,24 @@ Our goal is that as we iterate upon the design of our products, we document ever

We named it "queso" because we wanted a Texas-esque name and an easy way to refer to it internally. Also as we all know, everything is better with queso 🧀.

## Install
## Getting started
To preview these assets and accompanying docs locally, run the following commands:
```sh
yarn
```

```sh
yarn dev
```
Visit http://localhost:3000

This spins up a browsersync server and watch task for all SCSS and HTML files.

**Requirements**
- node >=8.11.3 (to be replaced with a docker container)


## Installing as a dependency

```sh
yarn add @texastribune/queso-ui --dev
Expand Down

0 comments on commit 79af158

Please sign in to comment.