Browse Source

add properties/methods headers

master
Brett Langdon 11 years ago
parent
commit
8dea42e7dc
1 changed files with 6 additions and 0 deletions
  1. +6
    -0
      README.md

+ 6
- 0
README.md View File

@ -35,8 +35,10 @@ for build in builds:
## API
### Environment(object)
#### Properties
* `type` - string
* `options` - mixed
#### Methods
* `__init__(self, type, options)`
* `__repr__(self)`
* `as_dict(self)`
@ -44,7 +46,9 @@ for build in builds:
* `as_yaml(self)`
### Script(object)
#### Properties
* `commands` - list
#### Methods
* `__init__(self, commands)`
* `__repr__(self)`
* `as_dict(self)`
@ -52,12 +56,14 @@ for build in builds:
* `as_yaml(self)`
### Build(object)
#### Properties
* `env` - Environment
* `before_build` - Script
* `build` - Script
* `after_build` - Script
* `after_success` - Script
* `after_failure` - Script
#### Methods
* `__init__(self, env, before_build, build, after_build, after_success, after_failure)`
* `__repr__(self)`
* `as_dict(self)`


Loading…
Cancel
Save