From 3498037163e5e9d356191e48d5ecde1ba3d57210 Mon Sep 17 00:00:00 2001 From: dannyrb Date: Wed, 4 Sep 2019 21:54:29 -0400 Subject: [PATCH] docs(readme): npm links and package descriptions --- README.md | 35 ++++++++++++++++++++++------------- 1 file changed, 22 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3d4fa0d50..94904f52e 100644 --- a/README.md +++ b/README.md @@ -215,12 +215,12 @@ more about it in our [Architecture Documentation][ohif-architecture]. These projects comprise the -| Name | Description | Links | -| ------------------------------- | ----------- | ----- | -| [@ohif/core][platform-core] | | NPM | -| [@ohif/i18n][platform-i18n] | | NPM | -| [@ohif/viewer][platform-viewer] | | NPM | -| [@ohif/ui][platform-ui] | | NPM | +| Name | Description | Links | +| ------------------------------- | ---------------------------------------------------------------------------------------------------- | ----------------- | +| [@ohif/core][platform-core] | Business logic and classes that model the data, services, and extensions that are framework agnostic | [NPM][core-npm] | +| [@ohif/i18n][platform-i18n] | Language files and small API for wrapping component/ui text for translations | [NPM][i18n-npm] | +| [@ohif/viewer][platform-viewer] | The OHIF Viewer. Where we consume and configure all platform library's and extensions | [NPM][viewer-npm] | +| [@ohif/ui][platform-ui] | Reusable React components we consume and compose to build our Viewer's UI | [NPM][ui-npm] | ### Extensions @@ -228,13 +228,13 @@ This is a list of Extensions maintained by the OHIF Core team. It's possible to customize and configure these extensions, and you can even create your own. You can [read more about extensions here][ohif-extensions]. -| Name | Description | Links | -| -------------------------------------------------------------- | ----------- | ----- | -| [@ohif/extension-cornestone][extension-cornerstone] | | NPM | -| [@ohif/extension-dicom-html][extension-dicom-html] | | NPM | -| [@ohif/extension-dicom-microscopy][extension-dicom-microscopy] | | NPM | -| [@ohif/extension-dicom-pdf][extension-dicom-pdf] | | NPM | -| [@ohif/extension-vtk][extension-vtk] | | NPM | +| Name | Description | Links | +| -------------------------------------------------------------- | ------------------------------------------------------- | ---------------------- | +| [@ohif/extension-cornestone][extension-cornerstone] | 2D image viewing, annotation, and segementation tools | [NPM][cornerstone-npm] | +| [@ohif/extension-dicom-html][extension-dicom-html] | Support for viewing DICOM SR as rendered HTML | [NPM][html-npm] | +| [@ohif/extension-dicom-microscopy][extension-dicom-microscopy] | Whole slide microscopy viewing | [NPM][microscopy-npm] | +| [@ohif/extension-dicom-pdf][extension-dicom-pdf] | View DICOM wrapped PDFs in a viewport | [NPM][pdf-npm] | +| [@ohif/extension-vtk][extension-vtk] | Volume rendering, reconstruction, and 3D visualizations | [NPM][vtk-npm] | ## Acknowledgments @@ -304,13 +304,22 @@ MIT © [OHIF](https://github.com/OHIF) [extensions-url]: https://docs.ohif.org/advanced/extensions.html [platform-core]: platform/core/README.md +[core-npm]: https://www.npmjs.com/package/@ohif/core [platform-i18n]: platform/i18n/README.md +[i18n-npm]: https://www.npmjs.com/package/@ohif/i18n [platform-ui]: platform/ui/README.md +[ui-npm]: https://www.npmjs.com/package/@ohif/ui [platform-viewer]: platform/viewer/README.md +[viewer-npm]: https://www.npmjs.com/package/@ohif/viewer [extension-cornerstone]: extensions/cornerstone/README.md +[cornerstone-npm]: https://www.npmjs.com/package/@ohif/extension-cornerstone [extension-dicom-html]: extensions/dicom-html/README.md +[html-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-html [extension-dicom-microscopy]: extensions/dicom-microscopy/README.md +[microscopy-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-microscopy [extension-dicom-pdf]: extensions/dicom-pdf/README.md +[pdf-npm]: https://www.npmjs.com/package/@ohif/extension-dicom-pdf [extension-vtk]: extensions/vtk/README.md +[vtk-npm]: https://www.npmjs.com/package/@ohif/extension-vtk