From 345a9dca472d41269396bf2a4a27612af67a1eb1 Mon Sep 17 00:00:00 2001 From: Vadim Makeev Date: Sun, 13 Dec 2015 06:43:28 +0300 Subject: [PATCH] Updated readme --- README.md | 52 ++++++++++++++++++++-------------------------------- 1 file changed, 20 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 52ee1c9..bcc69e0 100644 --- a/README.md +++ b/README.md @@ -1,40 +1,28 @@ -# Shower HTML presentation engine +# Shower Presentation Template -Follow [@shower_me](https://twitter.com/shower_me) for support and updates. +> Shower ['ʃəuə] noun. A person or thing that shows. -To see Shower in action: +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 +6. Extensible by plugin system -- Open [shwr.me](http://shwr.me/) -- Click any slide to enter presentation mode -- Use arrow keys or presenter remote to navigate -- Press `Esc` to exit presentation mode +Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/core/) with plugins. [See it in action](http://shwr.me/). 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. -See [Wiki](https://github.com/shower/shower/wiki) for more information about how to use Shower. +## Quick Start -## Using Shower +1. Download and unzip [template archive](http://shwr.me/shower.zip) +2. Open `index.html` and start creating your presentation in HTML -There are two ways of making presentation using Shower: you can just download an archive with all you need or you can install needed Shower modules using [npm](https://www.npmjs.org) or [bower](http://bower.io). +## Advanced -### Simple Way +If you’re familiar with [npm](https://www.npmjs.com/) you can install Shower’s core and themes manually: `npm install shower-core shower-ribbon`. The same packages available in [bower](http://bower.io/). -In a simple way you just download the latest Shower version with built-in themes and use it. +For more details see short [video](https://www.youtube.com/watch?v=l2OelK_hIro) with advanced usage examples and built-in `publish` and `archive` commands explained. -1. Download and unarchive [shower.zip](http://shwr.me/shower.zip) -2. Open `index.html` in any code or text editor, edit your slides in HTML -3. Use `pictures` folder for pictures used in presentation -4. Once finished, open `index.html` in a browser, enter full screen and start presenting - -### Advanced Way - -Advanced way allows you to manually install needed Shower packages and requires [Node.js](http://nodejs.org/) installed together with package managment system: `npm` or `bower`. - -1. Run `npm install shower-core shower-ribbon` -2. Link core and theme files in `node_modules` folder to your presentation file -3. You probably know what to do next, it’s an advanced way - -**Note:** you can use `bower` instead of `npm` or `shower-bright` instead of `shower-ribbon` in command above to install Shower using Bower or get Bright theme. - -## Usage examples +## Usage Examples - [Clear and Sharp](http://pepelsbey.net/pres/clear-and-sharp/) - [CSS Management](http://pepelsbey.net/pres/knife-train/) @@ -43,15 +31,15 @@ Advanced way allows you to manually install needed Shower packages and requires - [Web In Curves](http://pepelsbey.net/pres/web-in-curves/) - [Sense Coding](http://pepelsbey.net/pres/sense-coding/) -## Browser support +## Browser Support Latest stable versions of Chrome, Internet Explorer, Firefox, Opera and Safari are supported. ## Contributing -You’re always welcome to contibute. 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](https://github.com/shower/shower/blob/master/Contributing.md) for more details. +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: [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). +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). --- -Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](https://github.com/shower/shower/wiki/MIT-License) for details. \ No newline at end of file +Licensed under [MIT License](LICENSE.md).