Skip to content

Instantly share code, notes, and snippets.

@javisantana

javisantana/api.md

Last active December 22, 2015 03:49
Show Gist options
  • Star 7 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save javisantana/6413167 to your computer and use it in GitHub Desktop.
Save javisantana/6413167 to your computer and use it in GitHub Desktop.
Download ZIP
this is a small API documentation template for your projects
Raw
api.md

Library or whatever title

Here what the library can do for other people

dead simple code example

API definition

Class Name

description

  working example

Class.Method(params)

description

Usage example

  working example

Params

param type Default Description
param1 string hello blablah

Returns and exceptions

return when sucessfully and fail

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment