# Shower

<img src="packages/shower/pictures/logo.png" width="250" alt="Shower logo">

> Shower ['ʃəuə] noun. A person or thing that shows.

1. Built on HTML, CSS and vanilla JavaScript.
2. Works in all modern browsers.
3. Themes are separated from engine.
4. Fully keyboard accessible.
5. Printable to PDF.

[See it in action](https://shwr.me/). Includes [Ribbon](packages/ribbon/) and [Material](packages/material/) themes, and [core](packages/core/) with plugins.

Follow [@shower_me](https://twitter.com/shower_me) for support and updates, [file an issue](https://github.com/shower/shower/issues/new) if you have any.

## Packages

| Package | Description |
|---------|-------------|
| [@shower/core](packages/core/) | Presentation engine: slide management, navigation, progress bar, timer |
| [@shower/material](packages/material/) | Material Design theme |
| [@shower/ribbon](packages/ribbon/) | Ribbon theme |
| [@shower/shower](packages/shower/) | Ready-to-use presentation template |
| [@shower/cli](packages/cli/) | CLI tool for creating, serving, bundling, and publishing presentations |

## Quick Start

1. Download and unzip [shower.zip](http://shwr.me/shower.zip) template archive.
2. Open `index.html` in any text editor and start creating your presentation.

## Quick Start via CLI

You'll need [Node.js](https://nodejs.org/) installed on your computer.

1. Install Shower CLI utility: `npm install -g @shower/cli`.
2. Create your presentation: `shower create`.

Read more on the [@shower/cli](packages/cli/) page.

## Browser Support

Latest stable versions of Chrome, Edge, Firefox, and Safari are supported.

## Contributing

You're always welcome to contribute. Fork project, make changes and send it as pull request. But it's better to file an [issue](https://github.com/shower/shower/issues) with your idea first. Read [contributing rules](CONTRIBUTING.md) for more details.

Main contributors in historical order: [pepelsbey](https://github.com/pepelsbey), [jahson](https://github.com/jahson), [miripiruni](https://github.com/miripiruni), [kizu](https://github.com/kizu), [artpolikarpov](https://github.com/artpolikarpov), [tonyganch](https://github.com/tonyganch), [zloylos](https://github.com/zloylos), [shvaikalesh](https://github.com/shvaikalesh).

---
Licensed under [MIT License](LICENSE.md).