Skip to content

Commit

Permalink
Adds documentation for transact
Browse files Browse the repository at this point in the history
Also updates changelog for tag.
  • Loading branch information
arecker committed Jan 8, 2016
1 parent 1ae1c30 commit d6c0cd3
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 3 deletions.
11 changes: 8 additions & 3 deletions CHANGELOG.md
Expand Up @@ -2,14 +2,19 @@
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## Unreleased
## 0.3 - 2016-01-07
### Added
- Docker image for testing.
- Gitter badge by Gitter Badger.
- This CHANGELOG.
- This CHANGELOG
- Some timezone support (possibly buggy)
- transact automation script and documentation
- Blood, sweat, and tears

### Changed
- Various UI improvements.
- Various UI improvements (overhauled)
- Profile page for changing password and verifying email
- Django upgrade to 1.9

### Removed
- `iteritems()` as incompatible with Python 3.
Expand Down
17 changes: 17 additions & 0 deletions README.md
Expand Up @@ -71,6 +71,23 @@ Lastly, install the project npm dependencies
You should now be able to recompile the static resources with the
command `grunt build`.

## Running

Once your create a superuser as described in the build steps, you have
access to the site as well as the admin page.

You can also register inferior users by more natural means by the
"register" link on the login page.

To automatically calculate rates and "open" each day, setup an hourly
cronjob to trigger the `transact` job. It should look something like
this.

0 * * * * /path/to/python /path/to/bennedetto/manage.py transact

The job is intended to run hourly to account for different timezones.
The app should open up each user's day precisely at _their_ midnight.

## Testing

To run the serverside tests
Expand Down

0 comments on commit d6c0cd3

Please sign in to comment.