update readme

extensions/ohif-cornerstone-extension/README.md

@@ -1,13 +1,33 @@
 # @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
+
+Extension Id: `cornerstone`
+
+- [Commands Module](#commands-module)
+- [Toolbar Module](#toolbar-module)
+- [Viewport Module](#viewport-module)
+
+## Commands Module
+
+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.
+
+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.
 
 | Command Name                 | Description                             | Store Contexts |
-| ---------------------------- | ----------- | -------------- |
+| ---------------------------- | --------------------------------------- | -------------- |
 | `rotateViewportCW`           |                                         | viewports      |
 | `rotateViewportCCW`          |                                         | viewports      |
 | `invertViewport`             |                                         | viewports      |
@@ -20,35 +40,48 @@ You can read more about [`Commands`](), [`Hotkeys`](), and the [`UserPreferences
 | clearAnnotations             | TODO                                    |                |
 | next/previous Image          | TODO                                    |                |
 | first/last Image             | TODO                                    |                |
-| `nextViewportDisplaySet`     |             | none           |
+| `nextViewportDisplaySet`     |                                         |                |
-| `previousViewportDisplaySet` |             | none           |
+| `previousViewportDisplaySet` |                                         |                |
+| `setToolActive`              | Activates tool for primary button/touch |                |
 
-### TODO:
+## Toolbar Module
 
-_SET TOOL_
+Our toolbar module contains definitions for:
 
-- [] Default Tool
+- `StackScroll`
-- [] Set Zoom Tool
+- `Zoom`
-- [] Set WWWC Tool
+- `Wwwc`
-- [] Set Pan Tool
+- `Pan`
-- [] Set Angle Measurement Tool
+- `Length`
-- [] Set Stack Scroll Tool
+- `Angle`
-- [] Set Magnify Tool
+- `Reset`
-- [] Set Length Tool
+- `Cine`
-- [] Set Annotate Tool
-- [] Set Pixel Probe Tool
-- [] Set Elliptical ROI Tool
-- [] Set Rectangle ROI Tool
 
-_OTHER_
+All use the `ACTIVE_VIEWPORT::CORNERSTONE` context.
 
-- Show/Hide CINE
+## Viewport Module
-- W/L Presets
+
-- W/L Presets config
+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 -->