Skip to content

Commit

Permalink
Final fixes for README
Browse files Browse the repository at this point in the history
  • Loading branch information
lanesawyer committed Nov 21, 2024
1 parent dc14de6 commit 2ab8e93
Showing 1 changed file with 17 additions and 9 deletions.
26 changes: 17 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,42 @@
# Allen Institute Vis
# Allen Institute Visualization TypeScript Libraries

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.
This repository contains a collection of TypeScript libraries to help software engineers 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
**The published packages are in alpha or beta states. They may fundamentally change as we continue building out functionality.** They are used in a production environment so they are relatively stable, but the APIs are not yet finalized.

TODO: Update this based on the package setup we decide to use
## Available Packages

The following is the list of packages and their descriptions:

- `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)

# Examples
We use [Semantic Versioning](https://semver.org/) for our packages. As of November 2024, all of them are in the `0.0.x` range, indicating that they are in early development.

## Level Of Support

We are planning on occasional updating this tool with no fixed schedule. Community involvement is encouraged through both issues and pull requests.

## 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.
See the `examples` directory for example projects using the packages. Over time, these examples will become more fully featured as the base tooling becomes more mature.

For details on running or adding new examples, see the `docs/examples.md` file.

# Contributing
## 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.

See the CONTRIBUTING.md file for more information on how to contribute to the project!

# Installation for Development
## 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.

Volta has experimental support for pnpm, so [follow the steps on their docs](https://docs.volta.sh/advanced/pnpm) to get it enabled.

# Using the Libraries
## Using the Libraries

See the `docs/using-packages.md` file for information on how to use the packages in your own projects.

0 comments on commit 2ab8e93

Please sign in to comment.