From 1281d2513ef24ef493ba9b75643903d3ec0ca5d1 Mon Sep 17 00:00:00 2001 From: Vadim Makeev Date: Mon, 3 Dec 2012 03:21:21 +0400 Subject: [PATCH] Rewritten readme --- Readme.md | 42 +++++++++++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 11 deletions(-) diff --git a/Readme.md b/Readme.md index 654a222..0773eba 100644 --- a/Readme.md +++ b/Readme.md @@ -1,28 +1,32 @@ # Shower -Сross-browser presentation template. +Presentation engine. Follow [@shower_me](http://twitter.com/shower_me/) for support and updates. + +To see Shower in action: - Open [shwr.me](http://shwr.me/) - Click any slide to enter presentation mode - Use arrow keys to navigate - Press `Esc` to exit presentation mode -See more details on how to use only keyboard to navagate [in documentation](shower/wiki/Shortcuts). +See more details on [using keyboard](shower/wiki/Shortcuts) to control Shower. -Follow [@shower_me](http://twitter.com/shower_me/) on Twitter for support and updates. +## Using Shower -## Supported Browsers +There are two ways of getting Shower: you can get full template or just an engine. -- Desktop platforms: Chrome, Firefox, Opera, Safari +To get full [template](https://github.com/shower/template) run following command: -Only latest stable versions of mentioned browsers are supported. +``` +git clone --recursive git@github.com:shower/template.git +``` -## Planned Support +To get only [shower](https://github.com/shower/shower) engine, run this: -- Desktop platforms: IE10 -- Mobile platforms: Mobile Safari, Opera Mobile - -Please address bugs and your suggestions to [Issues](http://github.com/pepelsbey/shower/issues). +``` +git clone --recursive git@github.com:shower/shower.git +``` +Or you can just download latest version as ZIP file: [template](https://github.com/downloads/shower/template/template.zip) and [shower](https://github.com/downloads/shower/shower/shower.zip). ## Usage examples @@ -34,4 +38,20 @@ Please address bugs and your suggestions to [Issues](http://github.com/pepelsbey - [Sense Coding](http://pepelsbey.net/pres/sense-coding/) - [Dynamic Graphics](http://pepelsbey.net/pres/dynamic-graphics/) +## Supported Browsers + +Desktop platforms: Chrome, Internet Explorer 10, Firefox, Opera, Safari. + +Only latest stable versions of mentioned browsers are supported. + +## Planned Support + +Mobile platforms: Chrome, Firefox, Safari, Opera Mobile. + +## 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](http://github.com/shower/shower/issues) first. + +Main contributors: @pepelsbey, @jahson, @miripiruni, @kizu. + Licensed under [MIT License](http://en.wikipedia.org/wiki/MIT_License), see [license page](shower/wiki/MIT-License) for details. \ No newline at end of file