One liner description of the repo.
More details...
Stable
Important: Important oddities and common gotchas.
Use this syntax: throughout document to call attention to important notes.
-
-
reponame.doStuff(arg1, arg2)
const reponame = require('ara-reponame')
const result = reponame.doStuff(32, 'ara-docs')
// console dot log the result here
reponame.doStuff(arg1, arg2)
Lorem Ipsum dostuff and some other things.
arg1
: descriptionarg2
: descriptionReturns type
. Description (if needed).
const bytes = reponame.doStuff(32, 'ara-docs')
reponame.anotherThing(arg1, arg2)
Lorem Ipsum anotherThing, which does another thing. Note: This does not do the other thing.
arg1
: descriptionarg2
: descriptionReturns type
. Description (if needed).
const bytes = reponame.anotherThing(32, 'ara-docs')
See command line README.
LGPL-3.0