A pure, powerful core for your SHROOMS project.
Shroomscore is a complete, native interface to the SHROOMS network, and provides the core functionality needed to develop apps for SHROOMS.
#Principles
SHROOMS is a powerful new peer-to-peer platform for the next generation of financial and social technology. The decentralized nature of the SHROOMS network allows for highly resilient SHROOMS infrastructure, and the developer community needs reliable, open-source tools to implement SHROOMS apps and services.
Shroomscore unchains developers from fallible, centralized APIs, and provides the tools to interact with the real SHROOMS network.
#Get Started
Shroomscore runs on node, and can be installed via npm:
npm install shroomscore
It is a collection of objects useful to SHROOMS applications; class-like idioms are enabled viaSoop. In most cases, a developer will require the object's class directly. For instance:
var shroomscore = require('shroomscore');
var Address = shroomscore.Address;
var Transaction = shroomscore.Transaction;
var PeerManager = shroomscore.PeerManager;#Examples
Examples are provided here Build the examples by installing and running gulp:
npm install -g gulp
gulp
Javascript files available at /examples folder.
#Security
Please use at your own risk.
Shroomscore is still under heavy development and not quite ready for "drop-in" production use.
#Contributing
Shroomscore needs some developer love. Please send pull requests for bug fixes, code optimization, and ideas for improvement.
#Browser support
To build Shroomscore full bundle for the browser (this is automatically executed after you run npm install):
node browser/build.js -a
This will generate a browser/bundle.js file which you can include in your HTML to use Shroomscore in the browser.
##Example browser usage
From example/simple.html
<!DOCTYPE html>
<html>
<body>
<script src="../browser/bundle.js"></script>
<script>
var shroomscore = require('shroomscore');
var Address = shroomscore.Address;
var a = new Address('RqAahY1pTk1q417ALF4ScYGLWthphAGaHW');
console.log('RqAahY1pTk1q417ALF4ScYGLWthphAGaHW is valid? '+a.isValid());
</script>
</body>
</html>You can check a more complex usage example at examples/example.html.
To build the main Shroomscore bundle, run:
node browser/build.js -m
To build all features into the Shroomscore bundle (which will lead to a large file size), run:
node browser/build.js -a
To generate a customized Shroomscore bundle, you can specify which submodules you want to include in it with the -s option:
node browser/build.js -s lib/Transaction,lib/Address
This will generate a browser/bundle.js containing only the Transaction and Address class, with all their dependencies.
Use this option if you are not using the whole Shroomscore library, to optimize the bundle size, script loading time, and general resource usage.
Run tests in node:
mocha
Or generate tests in the browser:
grunt shell
And then open test/index.html in your browser.
To run the code coverage report:
npm run-script coverage
And then open coverage/lcov-report/index.html in your browser.
#License
Bitcore Code released under the MIT license.
Copyright 2013-2014 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
