Skip to content

Commit

Permalink
Add command line options to README
Browse files Browse the repository at this point in the history
  • Loading branch information
jbutler committed Aug 2, 2015
1 parent 7d4a088 commit 7c531fa
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# auto-investor
Python library interfacing with LendingClub. Run this as a cronjob to automatically invest in notes that meet your investment criteria.
Don't waste your time managing your LendingClub account. Set up a set of filters and let `auto-investor` put your spare cash to work.

[![Build Status](https://travis-ci.org/jbutler/auto-investor.svg?branch=master)](https://travis-ci.org/jbutler/auto-investor)

Expand All @@ -8,6 +8,11 @@ Python library interfacing with LendingClub. Run this as a cronjob to automatica
* pyparsing
* requests

## Command Line Options
Run `python main.py --help` for the most current list of command line options. Currently there are two supported options.
* `-p`, `--productionMode`: This is a required option to do anything interesting. `auto-investor` will not transfer money into your account or invest in loans without it.
* `-t`, `--testFilters`: This is a special mode that will retrieve the currently listed loans and apply each filter to give you confidence that they are well formed. It is recommended to run this after updating your loan filters. No notes will be purchased.

## Configuration
Account configuration and lending criteria are two pieces that you'll need/want to tweak. There are separate config files for each.

Expand Down

0 comments on commit 7c531fa

Please sign in to comment.