Skip to content

Latest commit

 

History

History
24 lines (14 loc) · 1.02 KB

README.md

File metadata and controls

24 lines (14 loc) · 1.02 KB
Raw

itinerum-mobile-api Documentation

Live version: https://trip-lab.github.io/itinerum-mobile-api-docs

Project repository: https://github.com/TRIP-Lab/itinerum-mobile-api

Project homepage: https://itinerum.ca

This repository contains the source for the itinerum-mobile-api static documentation generated with Slate. The documentation should include detailed explanations and examples for how a client should submit data to an instance of the mobile API.

Contributing

  1. Fork this repository on GitHub.
  2. Clone your forked repository (not our original one) to your hard drive with git clone https://github.com/YOURUSERNAME/itinerum-mobile-api-docs.git
  3. cd itinerum-mobile-api-docs
  4. Edit ./source/index.html.md to add or edit API usage information.
  5. git commit and git push edits to your master branch.
  6. Issue a pull request so changes will be reviewed and merged to the official documentation.