Skip to content
This repository was archived by the owner on Oct 1, 2024. It is now read-only.

Commit 9efcade

Browse files
author
george
committed
update readme
1 parent bd1cc89 commit 9efcade

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
![Undernet](site/assets/images/github-logo.png?raw=true)
1+
![Undernet](app/assets/images/github-logo.png?raw=true)
22

33
[![CircleCI](https://circleci.com/gh/geotrev/undernet/tree/master.svg?style=svg)](https://circleci.com/gh/geotrev/undernet/tree/master) [![devDependencies Status](https://david-dm.org/geotrev/undernet/dev-status.svg)](https://david-dm.org/geotrev/undernet?type=dev) [![dependencies Status](https://david-dm.org/geotrev/undernet.svg)](https://david-dm.org/geotrev/undernet) [![npm version](https://badge.fury.io/js/undernet.svg)](https://badge.fury.io/js/undernet) ![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
44

@@ -53,33 +53,33 @@ First fork the project on Github. Then set up locally.
5353
```sh
5454
$ git clone git@github.com:USER_NAME/undernet.git
5555
$ cd undernet/
56-
$ npm install
56+
$ npm install # or `yarn install`
5757
```
5858

5959
The site is both a demo and marketing tool. It is built with my own webpack setup called [Pulsar](https://github.com/geotrev/pulsar). It's basically just Webpack + React, so don't panic. :)
6060

6161
### Run the dev server
6262

6363
```sh
64-
$ npm run watch
64+
$ yarn watch
6565
```
6666

6767
### Make a production build (mostly for sanity checks)
6868

6969
```sh
70-
$ npm run build
70+
$ yarn build
7171
```
7272

7373
### Run Jest tests (for site + framework)
7474

7575
```sh
76-
$ npm test
76+
$ yarn test
7777
```
7878

7979
### Load tests on file save
8080

8181
```sh
82-
$ npm run test:watch
82+
$ yarn test:watch
8383
```
8484

8585
### Building the framework
@@ -88,10 +88,10 @@ The site itself is a demo of the framework, so you should be able to work on the
8888

8989
The build environment works in any bash/unix environment. If you're on Windows, that means you'll need [WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) or an equivalent solution.
9090

91-
If you've already run `npm install`, these commands should Just Work™.
91+
If you've already run `yarn install`, these commands should Just Work™.
9292

9393
```sh
94-
$ npm run build:dist
94+
$ yarn build:dist
9595
```
9696

9797
The script processes the SCSS and JS, then compiles the output to the `dist/` folder.
@@ -101,7 +101,7 @@ The script processes the SCSS and JS, then compiles the output to the `dist/` fo
101101
To continually reload fresh JS assets while running the site's dev server, run the below command in a separate terminal session.
102102

103103
```sh
104-
$ npm run js:watch
104+
$ yarn js:watch
105105
```
106106

107107
### New releases

0 commit comments

Comments
 (0)