Skip to content

Commit

Permalink
README.md updates including params
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan committed Nov 16, 2019
1 parent d1e9275 commit 2061cd9
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,13 @@ This project uses machine learning [neural networks](https://en.wikipedia.org/wi

## :star2: Demo

Coming soon...
**[See it in action](https://sts-ryan-holton.github.io/loan-risk-score/)**

#### :wrench: Param options

- `?enable_seed_data=true` - pass this to generate random data to test the system.
- `?enable_logs=true` - pass this to get real-time console updates as Brain JS learns your data.
- `?enable_risk_factor_logging=true` - pass this to see your individual risk factors, logged to the console.


## :bulb: How it works
Expand Down Expand Up @@ -46,20 +52,20 @@ Install the scraper, you need **Node JS 10 or greater**

``` bash
# clone project
$ git clone [email protected]:team8digital/llcV2.git
$ git clone [email protected]:sts-ryan-holton/loan-risk-score.git

# install dependencies.
$ npm install
```

### Starting
### :wrench: Starting

``` bash
# start scraping
$ node scraper/scrape-jobs.js
```

### Starting - With options
### :wrench: Starting - With options

``` bash
# start scraping with options (you can pass all, or some of the following with number format)
Expand Down

0 comments on commit 2061cd9

Please sign in to comment.