PR feedback from Skyler

README.md

@@ -3,17 +3,24 @@
 This repository contains a collection of packages for building scalable visualization tools at the Allen Institute. It houses the `vis-[package name]` packages on the Allen Institute GitHub organization's NPM package registry.
 
 # Available Packages
+
 TODO: Update this based on the package setup we decide to use
 
+-   `vis-dzi`: A renderer for [Deep Zoom Images](https://en.wikipedia.org/wiki/Deep_Zoom)
 -   `vis-geometry`: A collection of vector functions for 2D and 3D geometry
--   `scatterbrain`: A collection of useful utitilites used to build our big-data, scalable, scatterplot tool "Scatterbrain" in the Brain Knowledge Platform
+-   `vis-omezarr`: A renderer for [OME-Zarr](https://ngff.openmicroscopy.org/latest/) datasets
+-   `vis-scatterbrain`: A collection of useful utilities used to build our big-data, scalable, scatterplot tool "Scatterbrain" in the Brain Knowledge Platform (will be renamed to `vis-core` in the future)
 
 # Examples
 
 See the `example` directory for example projects using the packages. Over time, these examples will become simpler as the base tooling becomes more mature.
 
 For details on running or adding new examples, see the `docs/examples.md` file.
 
+# Contributing
+
+Contributions are welcome! We're currently breaking apart the Scatterbrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR.
+
 # Installation for Development
 
 This project uses [Node.js](https://nodejs.org) and [pnpm](https://pnpm.io/). We use [Volta](https://volta.sh/) to manage the versions of each. If you're not using Volta, check the "volta" key in the root `package.json` for the Node and pnpm versions we're using when developing.
@@ -23,10 +30,3 @@ Volta has experimental support for pnpm, so [follow the steps on their docs](htt
 # Using the Libraries
 
 See the `docs/using-packages.md` file for information on how to use the packages in your own projects.
-
-# Contributing
-
-Contributions are welcome! We're currently breaking apart the Scatterbrain component into smaller, more manageable packages. If you have a package that you think would be useful to others, please open a PR.
-
-## Getting Started
-TODO: Add technology needed for running the project locally for development

docs/examples.md

@@ -1,6 +1,6 @@
 # Examples
 
-Examples are located in the `examples` directory. There is a single project that runs all the examples.
+Examples are located in the `examples` directory. There is a single command that runs all the examples on one website: `npm run dev`
 
 ## Adding New Examples
 

docs/packages.md

@@ -2,8 +2,14 @@
 
 This repository holds multiple published packages. The current list of packages is below:
 
-- `@alleninstitute/vis-geometry` - Utils for geometric operations
-- `@alleninstitute/vis-core` - Scatterbrain stuff, but all this is sorta just core utils. Maybe rename to vis-core?
-- `@alleninstitute/vis-react` - React components wrapping up the visualizations defined in `vis-core`
+-   `vis-dzi`: A renderer for [Deep Zoom Images](https://en.wikipedia.org/wiki/Deep_Zoom)
+-   `vis-geometry`: A collection of vector functions for 2D and 3D geometry
+-   `vis-omezarr`: A renderer for [OME-Zarr](https://ngff.openmicroscopy.org/latest/) datasets
+-   `vis-scatterbrain`: A collection of useful utilities used to build our big-data, scalable, scatterplot tool "Scatterbrain" in the Brain Knowledge Platform (will be renamed to `vis-core` in the future)
 
 To install and use these packages, see the instructions in [using-packages.md](./using-packages.md).
+
+## Future Packages
+
+-   `@alleninstitute/vis-core` - The core utilities common across all visualizations. This package will be the foundation for all other packages.
+-   `@alleninstitute/vis-react` - React component implementations of each of the visualization packages.