From 75288d986dd88b1d2e44b0dc8fe4625485e2e07c Mon Sep 17 00:00:00 2001
From: dannyrb <danny.ri.brown@gmail.com>
Date: Thu, 20 Jun 2019 22:57:38 -0400
Subject: [PATCH] update readme

---
 .../ohif-cornerstone-extension/README.md      | 107 ++++++++++++------
 1 file changed, 70 insertions(+), 37 deletions(-)

diff --git a/extensions/ohif-cornerstone-extension/README.md b/extensions/ohif-cornerstone-extension/README.md
index 199da64ca..4f3ac0953 100644
--- a/extensions/ohif-cornerstone-extension/README.md
+++ b/extensions/ohif-cornerstone-extension/README.md
@@ -1,54 +1,87 @@
 # @ohif/extension-cornerstone
 
-## Commands
+This extension adds support for viewing and manipulating 2D medical images via a
+viewport. The underlying implementation wraps the
+`cornerstonejs/react-cornerstone-viewport`, and provides basic commands and
+toolbar buttons for common actions.
 
-This extensions includes the following `Commands` and `Command Definitions`. These can be registered with `@ohif/core`'s `CommandManager`. After registering the commands, they can be bound to `hotkeys` using the `HotkeysManager` and listed in the `UserPreferences` modal.
+<!-- TODO: Simple image or GIF? -->
 
-You can read more about [`Commands`](), [`Hotkeys`](), and the [`UserPreferences` Modal]() in their respective locations in the OHIF Viewer's documentation.
+#### Index
 
-| Command Name                 | Description | Store Contexts |
-| ---------------------------- | ----------- | -------------- |
-| `rotateViewportCW`           |             | viewports      |
-| `rotateViewportCCW`          |             | viewports      |
-| `invertViewport`             |             | viewports      |
-| `flipViewportVertical`       |             | viewports      |
-| `flipViewportHorizontal`     |             | viewports      |
-| `scaleUpViewport`            |             | viewports      |
-| `scaleDownViewport`          |             | viewports      |
-| `fitViewportToWindow`        |             | viewports      |
-| `resetViewport`              |             | viewports      |
-| clearAnnotations             | TODO        |                |
-| next/previous Image          | TODO        |                |
-| first/last Image             | TODO        |                |
-| `nextViewportDisplaySet`     |             | none           |
-| `previousViewportDisplaySet` |             | none           |
+Extension Id: `cornerstone`
 
-### TODO:
+- [Commands Module](#commands-module)
+- [Toolbar Module](#toolbar-module)
+- [Viewport Module](#viewport-module)
 
-_SET TOOL_
+## Commands Module
 
-- [] Default Tool
-- [] Set Zoom Tool
-- [] Set WWWC Tool
-- [] Set Pan Tool
-- [] Set Angle Measurement Tool
-- [] Set Stack Scroll Tool
-- [] Set Magnify Tool
-- [] Set Length Tool
-- [] Set Annotate Tool
-- [] Set Pixel Probe Tool
-- [] Set Elliptical ROI Tool
-- [] Set Rectangle ROI Tool
+This extensions includes the following `Commands` and `Command Definitions`.
+These can be registered with `@ohif/core`'s `CommandManager`. After registering
+the commands, they can be bound to `hotkeys` using the `HotkeysManager` and
+listed in the `UserPreferences` modal.
 
-_OTHER_
+You can read more about [`Commands`][docs-commands], [`Hotkeys`][docs-hotkeys],
+and the [`UserPreferences` Modal][docs-userprefs] in their respective locations
+in the OHIF Viewer's documentation.
 
-- Show/Hide CINE
-- W/L Presets
-- W/L Presets config
+| Command Name                 | Description                             | Store Contexts |
+| ---------------------------- | --------------------------------------- | -------------- |
+| `rotateViewportCW`           |                                         | viewports      |
+| `rotateViewportCCW`          |                                         | viewports      |
+| `invertViewport`             |                                         | viewports      |
+| `flipViewportVertical`       |                                         | viewports      |
+| `flipViewportHorizontal`     |                                         | viewports      |
+| `scaleUpViewport`            |                                         | viewports      |
+| `scaleDownViewport`          |                                         | viewports      |
+| `fitViewportToWindow`        |                                         | viewports      |
+| `resetViewport`              |                                         | viewports      |
+| clearAnnotations             | TODO                                    |                |
+| next/previous Image          | TODO                                    |                |
+| first/last Image             | TODO                                    |                |
+| `nextViewportDisplaySet`     |                                         |                |
+| `previousViewportDisplaySet` |                                         |                |
+| `setToolActive`              | Activates tool for primary button/touch |                |
+
+## Toolbar Module
+
+Our toolbar module contains definitions for:
+
+- `StackScroll`
+- `Zoom`
+- `Wwwc`
+- `Pan`
+- `Length`
+- `Angle`
+- `Reset`
+- `Cine`
+
+All use the `ACTIVE_VIEWPORT::CORNERSTONE` context.
+
+## Viewport Module
+
+Our Viewport wraps [cornerstonejs/react-cornerstone-viewport][react-viewport]
+and is connected the redux store. This module is the most prone to change as we
+hammer out our Viewport interface.
+
+## Resources
+
+### Repositories
+
+- [cornerstonejs/react-cornerstone-viewport][react-viewport]
+- [cornerstonejs/cornerstoneTools][cornerstone-tools]
+- [cornerstonejs/cornerstone][cornerstone]
 
 <!--
   Links
   -->
 
 <!-- prettier-ignore-start -->
+[docs-commands]: https://www.com
+[docs-hotkeys]: https://www.com
+[docs-userprefs]: htt
+[react-viewport]: https://github.com/cornerstonejs/react-cornerstone-viewport
+[cornerstone-tools]: https://github.com/cornerstonejs/cornerstoneTools
+[cornerstone]: https://github.com/cornerstonejs/cornerstone
 <!-- prettier-ignore-end -->