Commits

Jason R. Coombs committed 872e920

Updated README to include a description of the accounts.json file. Fixes #1

Comments (0)

Files changed (1)

 
 * Integrate some of the most common institutions.
 
+Accounts File
+-------------
+
+The "ofx download-all" command of `jaraco.financial` will retrieve the
+OFX transactions in a batch for a group of accounts defined in a JSON file.
+Currently, that file must be located in ~/Documents/Financial/accounts.json.
+The file should be a JSON list of objects,
+each with `institution` and `account` attributes. It should also have a
+`type` property of "checking", "savings", "creditline", or other appropriate
+OFX type. The institution should reference an institution installed with
+jaraco.financial, such as those defined in `jaraco.institutions
+<href="http://bitbucket.org/jaraco/jaraco.institutions">`_. The institution
+name must match exactly. Here is an
+example accounts.json::
+
+	[
+		{
+			"institution": "Bank of America",
+			"account": "12345679",
+			"type": "savings"
+		},
+		{
+			"institution": "Wells Fargo",
+			"account": "872634126",
+			"type": "moneymrkt"
+		},
+		{
+			"institution": "Chase (credit card)",
+			"account": "4000111122223333",
+			"username": "myusername"
+		}
+	]
+
+The `username` attribute must be included if the username of the local user
+(running the ofx command) differs from the account name on the account.
+
 Changes
 -------
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.