Skip to content

Commit 0a24821

Browse files
committed
update readme a bit more
1 parent e45a3af commit 0a24821

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,43 @@
11
# react-workflow-viz
22
React component for visualizing CWL-like workflows (and similar data).
33

4-
This is in alpha/beta phase.
4+
This repository is in alpha/beta phase, and is provided with very, very limited support to folks outside of HMS. Hopefully, in the future this will change!
55

6-
7-
This package is being used by HMS-DBMI in the [4DN Data Portal](https://data.4dnucleome.org/experiment-set-replicates/4DNESMU2MA2G/#graph-section) to show provenance of analytical pipeline runs.
6+
Currently, this package is being used by HMS-DBMI in the [4DN Data Portal](https://data.4dnucleome.org/experiment-set-replicates/4DNESMU2MA2G/#graph-section) to show provenance of analytical pipeline runs.
87
Also being used in [CGAP](https://cgap.hms.harvard.edu) for similar purposes.
98

109
Check out a live demo at [unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html](https://unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html). _Note: This link points to the index.html file in the distributable NPM package (and in this repo)._
1110

1211
[![Gif of CWL Workflow Viz](https://i.gyazo.com/0c5e73105b1f284c16a9cca03ec866ed.gif)](https://unpkg.com/@hms-dbmi-bgm/react-workflow-viz/index.html)
1312

13+
<br/>
14+
<br/>
1415

15-
## Build demo
16+
## Try Demo Locally
1617

17-
With a checkout of the repo:
18+
With a local clone and checkout of the repo:
1819
```
1920
npm install
2021
npm run build
2122
```
2223

2324
When it completes, load `file:///path-to-your-checkout/react-workflow-viz/index.html`.
24-
New testdata won't show with `npm run build` unless is already present in unpkg/npm. For local development, do the following
2525

26+
_Note: New test data won't show with `npm run build` unless it is already present in unpkg/npm._
2627

27-
### For Development
28+
<br/>
2829

29-
For local development (watches file, serves on localhost:8100), run `npm run dev`.
30+
### For Contributors/Collaborators
31+
For local development, run `npm run dev` (watches `/src/` files, serves on `localhost:8100`).
3032

33+
<br/>
34+
<br/>
3135

3236
## Changelog
33-
Changelog has been moved to `CHANGELOG.md` file in root directory. Please check there for updates.
37+
Changelog has been moved to `CHANGELOG.md` file in [repo's root directory](https://github.com/4dn-dcic/react-workflow-viz/blob/master/CHANGELOG.md). Please check there for updates.
3438

39+
<br/>
40+
<br/>
3541

3642
## Things to do
3743

0 commit comments

Comments
 (0)