Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 3.44 KB

README.md

File metadata and controls

83 lines (59 loc) · 3.44 KB
Raw

weifund-util

NPM version Build status Coverage Status NPM Downloads

A utility methods for the WeiFund client and library. Note, still in heavy development.

Install

npm install --save weifund-util

About

WeiFund uses a small set of methods to handle its campaign and registry data. There are many small utility methods that are needed to make these methods function. This library contains those methods.

Usage

const utils = require('weifund-util');

console.log(utils);

/* results in:
{
  isBigNumber: isBigNumber,
  etherScanAddressUrl: etherScanAddressUrl,
  etherScanTxHashUrl: etherScanTxHashUrl,
  parseCampaignRegistryData: parseCampaignRegistryData,
  buildInputsArray: buildInputsArray,
  oneDay: oneDay,
  parseSolidityMethodInterface: parseSolidityMethodInterface,
  emptyWeb3Address: emptyWeb3Address,
  parseMethodABIObject: parseMethodABIObject,
  capitalizeFirstLetter: capitalizeFirstLetter,
  filterXSSObject: filterXSSObject,
  nameContainsIDProperties: nameContainsIDProperties,
  parseSolidityMethodName: parseSolidityMethodName,
};
*/

Contributing

Please help better the ecosystem by submitting issues and pull requests to weifund-util. We need all the help we can get to build the absolute best linting standards and utilities. We follow the AirBNB linting standard. Please read more about contributing to weifund-util in the CONTRIBUTING.md.

Guides

You'll find more detailed information on using weifund-util and tailoring it to your needs in our guides:

  • User guide - Usage, configuration, FAQ and complementary tools.
  • Developer guide - Contributing to weifund-util and writing your own plugins & formatters.

Help out

There is always a lot of work to do, and will have many rules to maintain. So please help out in any way that you can:

  • Create, enhance, and debug rules (see our guide to "Working on rules").
  • Improve documentation.
  • Chime in on any open issue or pull request.
  • Open new issues about your ideas for making stylelint better, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • Create or contribute to ecosystem tools, like the plugins for Atom and Sublime Text.
  • Spread the word.

Please consult our Code of Conduct and Contributing docs before helping out.

We communicate via issues and pull requests.

Important documents

Licence

All Rights Reserved. WeiFund is currently exploring the appropriate 
license structure and this will be updated when a conclusion is reached.