@puzzleitc/puzzle-shell/README.md

The standard design for Puzzle tools

# Puzzle Shell

[![Linting](https://github.com/puzzle/puzzle-shell/actions/workflows/lint.yml/badge.svg)](https://github.com/puzzle/puzzle-shell/actions/workflows/lint.yml)
[![Storybook Build](https://github.com/puzzle/puzzle-shell/actions/workflows/storybook.yml/badge.svg?branch=main)](https://github.com/puzzle/puzzle-shell/actions/workflows/storybook.yml)
[![Software bill of materials (BOM)](https://github.com/puzzle/puzzle-shell/actions/workflows/bom.yml/badge.svg?branch=main)](https://github.com/puzzle/puzzle-shell/actions/workflows/bom.yml)

The standard design for Puzzle tools as a set of [Web Components](https://en.wikipedia.org/wiki/Web_Components).

The Puzzle Shell project strives for the following goals:

- Integration of internal tools & solutions into the Puzzle identity
- Uniform and consistent presentation with recognizability across tools & solutions
- Providing a flexible construction kit without rigid specifications

## Documentation

- 📓 [Changelog](./CHANGELOG.md)
- 🎨 [Puzzle Shell Storybook](https://puzzle.github.io/puzzle-shell)
- 🚀 [Install the Puzzle Shell](doc/install.md)
- 🔨 [Use the Puzzle Shell](doc/usage.md)
- 👩‍💻 [Develop & contribute](doc/dev.md)