Tommy Documentation

This repo contains the Tommy developer documentation in GitBook format.

The start the gitbook use the following command:

# install gitbook
npm install -g gitbook-cli

# start the local gitbook server
gitbook serve

# build the gitbook
gitbook build

Obtain your API key

Please contact [email protected] in order to obtain your API key.

Deployment

To deploy the docs to GitHub Pages use the following command:

./publish.sh

Bug Reports

If you find an issue with the Tommy API, SDK or documentation please post a bug report on the issue tracker

Contributing

To contribute to post a modification to the Tommy documentation please follow these steps:

1. Fork the repo (git clone [email protected]:tommyassociates/tommy-docs.git)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request