Skip to content

Latest commit

 

History

History
78 lines (55 loc) · 2.99 KB

README.md

File metadata and controls

78 lines (55 loc) · 2.99 KB
Raw

weifund-lib

A library with all WeiFund campaign data retrieval methods.

Install

npm install --save weifund-lib

Usage

// get campaigns method
const getCampaigns = require('weifund-lib').getCampaigns;

// get campaigns
getCampaigns({
  // set network
  // or 'testnet'
  network: 'ropsten',

  // set campaign selector
  // array (i.e. array of campaignIDs)
  selector: [0],
}, function (getCampaignError, campaignsResult) {
  // async callback with either error or camapign result
  console.log(campaignsResult);
});

About

The WeiFund library. This contains all methods needed to pull campaign data from IPFS or the blockchain.

Contributing

Please help better the ecosystem by submitting issues and pull requests to weifund-lib. 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-lib in the CONTRIBUTING.md.

Guides

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

  • User guide - Usage, configuration, FAQ and complementary tools.
  • Developer guide - Contributing to weifund-lib 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 weifund-lib better, and pull requests to show us how your idea works.
  • Add new tests to absolutely anything.
  • Work on improving performance of rules.
  • 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.