Skip to content

Commit d9241ef

Browse files
authored
Update README.md
1 parent 07a561d commit d9241ef

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

README.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,42 @@
11
[![Build Status](https://travis-ci.com/dcmjs-org/dicom-microscopy-viewer.svg?branch=master)](https://travis-ci.com/dcmjs-org/dicom-microscopy-viewer)
22

33
# DICOM Microscopy Viewer
4-
Web-based viewer for [DICOM Visible Light Whole Slide Microscopy Images](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_A.32.8.html).
4+
Vanilla JS library for web-based visualization of [DICOM VL Whole Slide Microscopy Image](http://dicom.nema.org/medical/dicom/current/output/chtml/part03/sect_A.32.8.html) datasets.
5+
The library only depends on [Openlayers](http://openlayers.org/) for rendering pyramid images and retrieves pyramid tiles (image frames) using [DICOMweb WADO-RS](https://www.dicomstandard.org/dicomweb/retrieve-wado-rs-and-wado-uri/).
56

67

7-
## Install
8+
## Installation
89

9-
The [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package can be installed via `npm` package manager:
10+
Install the [dicom-microscopy-viewer](https://www.npmjs.com/package/dicom-microscopy-viewer) package using the `npm` package manager:
1011

1112
```None
1213
npm install dicom-microscopy-viewer
1314
```
1415

15-
## Build
16+
## Building and testing
1617

17-
The library can be build locally with [rollup](https://rollupjs.org/guide/en):
18+
Build and test code locally:
1819

1920
```None
2021
git clone https://github.com/dcmjs-org/dicom-microscopy-viewer ~/dicom-microscopy-viewer
2122
cd ~/dicom-microscopy-viewer
2223
npm install
2324
npm run build
25+
npm test
2426
```
2527

26-
## Test
27-
28-
The library can be tested locally with [mochify](https://github.com/mantoni/mochify.js) (using [mocha](https://mochajs.org/) and [chai](http://www.chaijs.com/)):
28+
We use [rollup](https://rollupjs.org/guide/en) for bundling and [mochify](https://github.com/mantoni/mochify.js) for testing (based on [mocha](https://mochajs.org/) and [chai](http://www.chaijs.com/)).
2929

30-
```None
31-
git clone https://github.com/dcmjs-org/dicom-microscopy-viewer ~/dicom-microscopy-viewer
32-
cd ~/dicom-microscopy-viewer
33-
npm install
34-
npm test
35-
```
3630

3731
## Usage
3832

33+
The viewer can be embedded in any website.
34+
35+
First, create an instance of the `DICOMMicroscopy` viewer. The constructor requires an instance of `DICOMwebClient` for retrieving frames from the archive as well as the [Study Instance UID](http://dicom.nema.org/medical/dicom/2018b/output/chtml/part03/sect_C.7.2.html#para_a73c2743-6150-4a31-9da7-0d50edb8cd67) and [Series Instance UID](http://dicom.nema.org/medical/dicom/2018b/output/chtml/part03/sect_C.7.3.html#para_b0bcb555-c05c-4c1d-8b7e-8904168a3d38).
36+
37+
Second, call the `render()` method, passing it the HTML element or the name of the element, which shall contain the viewport.
38+
39+
3940
```js
4041
const url = 'http://localhost:8080/dicomweb';
4142
const client = new DICOMwebClient.api.DICOMwebClient({url});

0 commit comments

Comments
 (0)