Skip to content

Getable/rentable-footer

Repository files navigation

rentableFooter NPM version Build Status Dependency Status

footer component for rentable equipment experiment pages NOTE: You need to specify UTF-8 coding in your head tag, otherwise the copywrite symbol will display wonky.

Table of Contents generated with DocToc

Install

npm i -S @getable/rentable-footer

Usage

var rentableFooter = require('@getable/rentable-footer')

rentableFooter('Rainbow')

Methods

get (<String> string)

Returns the string passed to it.

Events

myEvent (<String> myString)

Emitted when x happens. Passes myString which is a y.

Tests

Tests are in tape.

  • npm test will run the tests in a browser
  • npm run tdd will run the tests in a browser on every file change.

Developing

To publish, run npm run release -- [{patch,minor,major}]

NOTE: you might need to sudo ln -s /usr/local/bin/node /usr/bin/node to ensure node is in your path for the git hooks to work

Requirements

  • npm > 2.0.0 So that passing args to a npm script will work. npm i -g npm
  • git > 1.8.3 So that git push --follow-tags will work. brew install git

License

Artistic 2.0 © Cristi Scheye