AraBlocks / ara-module-template

Ara repo template - documentation, github files, Travis CI and ESLint configs
https://ara.one
GNU Lesser General Public License v3.0
1 stars 1 forks source link

ara-reponame

Build Status

One liner description of the repo.

More details...

Table of Contents

Status

Stable

Important: Important oddities and common gotchas.

Use this syntax: throughout document to call attention to important notes.

Dependencies

Installation

Windows

-

Macos

-

Usage

reponame.doStuff(arg1, arg2)

Example

const reponame = require('ara-reponame')

const result = reponame.doStuff(32, 'ara-docs')

// console dot log the result here

API

reponame.doStuff(arg1, arg2)

Lorem Ipsum dostuff and some other things.

Returns type. Description (if needed).

Example

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.

Returns type. Description (if needed).

Example

const bytes = reponame.anotherThing(32, 'ara-docs')

CLI

See command line README.

Contributing

See Also

License

LGPL-3.0