cytoscape-weinberg
v1.0.0
Published
layout for project weinberg
Downloads
3
Maintainers
Readme
cytoscape-weinberg
Description
layout for project weinberg (demo)
Dependencies
- Cytoscape.js ^3.2.0
Usage instructions
Download the library:
- via npm:
npm install cytoscape-weinberg
, - via bower:
bower install cytoscape-weinberg
, or - via direct download in the repository (probably from a tag).
Import the library as appropriate for your project:
ES import:
import cytoscape from 'cytoscape';
import weinberg from 'cytoscape-weinberg';
cytoscape.use( weinberg );
CommonJS require:
let cytoscape = require('cytoscape');
let weinberg = require('cytoscape-weinberg');
cytoscape.use( weinberg ); // register extension
AMD:
require(['cytoscape', 'cytoscape-weinberg'], function( cytoscape, weinberg ){
weinberg( cytoscape ); // register extension
});
Plain HTML/JS has the extension registered for you automatically, because no require()
is needed.
API
TODO describe the API of the extension here.
Build targets
npm run test
: Run Mocha tests in./test
npm run build
: Build./src/**
intocytoscape-weinberg.js
npm run watch
: Automatically build on changes with live reloading (N.b. you must already have an HTTP server running)npm run dev
: Automatically build on changes with live reloading with webpack dev servernpm run lint
: Run eslint on the source
N.b. all builds use babel, so modern ES features can be used in the src
.
Publishing instructions
This project is set up to automatically be published to npm and bower. To publish:
- Build the extension :
npm run build:release
- Commit the build :
git commit -am "Build for release"
- Bump the version number and tag:
npm version major|minor|patch
- Push to origin:
git push && git push --tags
- Publish to npm:
npm publish .
- If publishing to bower for the first time, you'll need to run
bower register cytoscape-weinberg https://github.com/cheezmic/assets.git
- Make a new release for Zenodo.