dcmjs - npm Package Compare versions

Comparing version 0.2.1 to 0.2.2

package.json

 {
   "name": "dcmjs",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Javascript implementation of DICOM manipulation",
   "main": "build/dcmjs.js",
+  "module": "build/dcmjs.js",
   "directories": {
@@ -7,0 +8,0 @@ "example": "examples"

README.md

@@ -1,6 +0,11 @@
-# dcmjs
-JavaScript implementation of DICOM manipulation
+<div align="center">
+  <h1>dcmjs</h1>
 
-This code is an outgrowth of several efforts to implement web applications for medical imaging.
+  <p>JavaScript implementation of DICOM manipulation. This code is an outgrowth of several efforts to implement web applications for medical imaging.</p>
+</div>
 
+<hr />
+
+[![CircleCI](https://circleci.com/gh/dcmjs-org/dcmjs.svg?style=svg)](https://circleci.com/gh/dcmjs-org/dcmjs)
+
 **Note: this code is a work-in-progress and should not be used for production or clinical purposes**
@@ -10,5 +15,6 @@
 
-# Goals
+## Goals
 
-Overall the code should:
+_Overall the code should:_
+
 * Support reading and writing of correct DICOM objects
@@ -20,3 +26,4 @@ * Provide a programmer-friendly JavaScript environment for using and manipulating DICOM objects
 
-Architectural goals include:
+_Architectural goals include:_
+
 * Use modern JavaScript programming methods (currently ES6) but avoid heavy frameworks
@@ -26,3 +33,4 @@ * Leverage modern DICOM standards but avoid legacy parts
 
-Parts of DICOM that dcmjs will focus on:
+_Parts of DICOM that dcmjs will focus on:_
+
 * Enhanced Multiframe Images
@@ -33,44 +41,60 @@ * Segmentation Objects
 
-Parts of DICOM that dcmjs *will not* focus on:
+_Parts of DICOM that dcmjs *will not* focus on:_
+
 * DIMSE (legacy networking like C-FIND, C-MOVE, etc)
 * Physical Media (optical disks)
 
-# Status
+## Status
+
 Currently dcmjs is an early-stage development experiment.
-  ## Implemented
-  * Bidirectional conversion to and from part 10 binary DICOM and DICOM standard JSON encoding (as in [DICOMweb](http://dicomweb.org))
-  * Bidirectional convertion to and from DICOM standard JSON and a programmer-friendly high level version.
-  ## In development
-  * Creation of (correct) enhanced multiframe DICOM objects from legacy image objects
-  * Creation of (correct) derived DICOM objects such as Segmentations and Structured Reports
-  ## TODO
-  * Create a test suite of input and output DICOM objects
-  * Test interoperability with other DICOM implementations
-  * Add documentation
 
-# History
+```js
+// To install latest _stable_ release
+npm install --save dcmjs
+
+// To install latest code merged to master
+npm install --save dcmjs@dev
+```
+
+### Implemented
+  
+* Bidirectional conversion to and from part 10 binary DICOM and DICOM standard JSON encoding (as in [DICOMweb](http://dicomweb.org))
+* Bidirectional convertion to and from DICOM standard JSON and a programmer-friendly high level version.
+
+### In development
+
+* Creation of (correct) enhanced multiframe DICOM objects from legacy image objects
+* Creation of (correct) derived DICOM objects such as Segmentations and Structured Reports
+
+### TODO
+
+* Create a test suite of input and output DICOM objects
+* Test interoperability with other DICOM implementations
+* Add documentation
+
+## History
+
 * 2014
-  * [DCMTK](dcmtk.org) cross compiled to javascript at [CTK Hackfest](http://www.commontk.org/index.php/CTK-Hackfest-May-2014).
-While this was useful and powerful, it was heavyweight for typical web usage.
+  * [DCMTK](dcmtk.org) cross compiled to javascript at [CTK Hackfest](http://www.commontk.org/index.php/CTK-Hackfest-May-2014). While this was useful and powerful, it was heavyweight for typical web usage.
 * 2016
-  * A [Medical Imaging Web Appliction meeting at Stanford](http://qiicr.org/web/outreach/Medical-Imaging-Web-Apps/) and
-[follow-on hackfest in Boston](http://qiicr.org/web/outreach/MIWS-hackfest/) helped elaborate the needs for manipulating DICOM in pure Javascript.
-  * Based on [DICOM Part 10 read/write code](https://github.com/OHIF/dicom-dimse) initiated by Weiwei Wu of [OHIF](http://ohif.org), Steve Pieper [developed further features](https://github.com/pieper/sites/tree/gh-pages/dcmio) and 
-[examples of creating multiframe and segmentation objects](https://github.com/pieper/sites/tree/gh-pages/DICOMzero) discussed with
-the community at RSNA
+  * A [Medical Imaging Web Appliction meeting at Stanford](http://qiicr.org/web/outreach/Medical-Imaging-Web-Apps/) and [follow-on hackfest in Boston](http://qiicr.org/web/outreach/MIWS-hackfest/) helped elaborate the needs for manipulating DICOM in pure Javascript.
+  * Based on [DICOM Part 10 read/write code](https://github.com/OHIF/dicom-dimse) initiated by Weiwei Wu of [OHIF](http://ohif.org), Steve Pieper [developed further features](https://github.com/pieper/sites/tree/gh-pages/dcmio) and [examples of creating multiframe and segmentation objects](https://github.com/pieper/sites/tree/gh-pages/DICOMzero) discussed with the community at RSNA
 * 2017
   * At [NA-MIC Project Week 25](https://na-mic.org/wiki/Project_Week_25) Erik Ziegler and Steve Pieper [worked](https://na-mic.org/wiki/Project_Week_25/DICOM_Segmentation_Support_for_Cornerstone_and_OHIF_Viewer)
  with the community to define some example use cases to mix the pure JavaScript DICOM code with Cornerstone and [CornerstoneTools](https://github.com/chafey/cornerstoneTools).
- * 2018
-	 * Work continues to develop SR and SEG support to [OHIFViewer](http://ohif.org) allow interoperability with [DICOM4QI](https://legacy.gitbook.com/book/qiicr/dicom4qi/details)
- 
- # Support
- The developers gratefully acknowledge their reseach support:
- * Open Health Imaging Foundation ([OHIF](http://ohif.org))
- * Quantitative Image Informatics for Cancer Research ([QIICR](http://qiicr.org))
- * [Radiomics](http://radiomics.io)
- * The [Neuroimage Analysis Center](http://nac.spl.harvard.edu)
- * The [National Center for Image Guided Therapy](http://ncigt.org)
+* 2018
+  * Work continues to develop SR and SEG support to [OHIFViewer](http://ohif.org) allow interoperability with [DICOM4QI](https://legacy.gitbook.com/book/qiicr/dicom4qi/details)
+
+## Support
+
+The developers gratefully acknowledge their reseach support:
+
+* Open Health Imaging Foundation ([OHIF](http://ohif.org))
+* Quantitative Image Informatics for Cancer Research ([QIICR](http://qiicr.org))
+* [Radiomics](http://radiomics.io)
+* The [Neuroimage Analysis Center](http://nac.spl.harvard.edu)
+* The [National Center for Image Guided Therapy](http://ncigt.org)
+
 <!--stackedit_data:
 eyJoaXN0b3J5IjpbMTI4MTEyOTE1NV19
 -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

3240

increased by0.03%

Number of lines in readme file

97

increased by32.88%

Worsened metrics

Total package byte prevSize

850389

decreased by-5.79%

Number of downloads

17580

decreased by-11.45%

Number of package files

8

decreased by-46.67%

Number of medium supply chain risk alerts

1

increased byInfinity%

Published versions last months

0

decreased by-100%

No dependency changes