Create a gist now

Instantly share code, notes, and snippets.

@javisantana /api.md
Last active Dec 22, 2015

What would you like to do?
this is a small API documentation template for your projects

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