From 2ae499f68951d828ad87aa4e1dee7b0d67bdd4fd Mon Sep 17 00:00:00 2001 From: Vadim Makeev Date: Fri, 17 Apr 2020 22:21:36 +0300 Subject: [PATCH] Update readme --- README.md | 91 ++++++++++++++++++++++++++----------------------------- 1 file changed, 43 insertions(+), 48 deletions(-) diff --git a/README.md b/README.md index 85cd6e2..0d3d228 100644 --- a/README.md +++ b/README.md @@ -5,20 +5,53 @@ > 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 +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](http://shwr.me/). 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](https://shwr.me/). Includes [Ribbon](https://github.com/shower/ribbon/) and [Material](https://github.com/shower/material/) themes, and [core](https://github.com/shower/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. ## Quick Start -1. Download and unzip [template archive](http://shwr.me/shower.zip) -2. Open `index.html` and start creating your presentation +1. Download and unzip [shower.zip](http://shwr.me/shower.zip) template archive. +2. Open `index.html` in any test 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 [shower/cli](https://github.com/shower/cli/) page. + +## Quick Start with Hosting + +You’ll need [Node.js](https://nodejs.org/) installed on your computer. + +1. Copy this repository to your account via GitHub. + 1. Open [import page](https://github.com/new/import). + 2. Use `https://github.com/shower/shower` for the repository URL + 3. Use your presentation name. + 4. Clone the resulted repository to your computer. +2. Install dependencies `npm install` and start a local server `npm start`. +3. Start editing your slides with live-reload. + +Once you’re done you can build a clean copy of your slides: + + npm run prepare + +You’ll find your presentation in `prepared` folder. You can also run `npm run archive` to get the same files in `presentation.zip`. + +Publish your presentation online by running: + + npm run publish + +You’ll have your slides published to `https://USER.github.io/REPO/`. ## Deploy to Netlify @@ -26,45 +59,7 @@ By clicking the button below you can fork this repo and deploy it to Netlify. [![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/shower/shower) -By doing this you would get a GitHub repo linked with Netlify in a way any change to the repo would trigger a shower rebuild and deploy to Netlify servers, which allows for a really easy way to create and share Shower presentation without the need to install anything locally. - -## Advanced - -### Get your own Shower - -1. Copy Shower in your account via [GitHub](#copy-via-github) or via [CLI](#copy-via-cli) -2. Install dependencies `npm install` and start it `npm start`. - -Once you’re done you can build a clean copy of your slides: - - npm run prepare - -And you’ll find your presentation in `prepared` folder with only needed files in it. You can also run `npm run archive` to get the same files in `archive.zip`. But there’s more! You can easily publish your presentation online by running: - - npm run publish - -And you’ll have your slides published to `http://USER.github.io/REPO/`. - -#### Copy via GitHub - -1. Open [import page](https://github.com/new/import). -2. For the repository URL use `https://github.com/shower/shower`. -3. For the name use any name you want, your presentation name would be the best. -4. Clone the resulted repository to your computer. - -#### Copy via CLI - -1. Сlone this repository `git clone --depth=1 git@github.com:shower/shower.git`, (`--depth=1` will make it way faster). -2. [Create](https://github.com/new) a new blank repository and copy its cloning address `git@github.com:USER/REPO.git`. -3. Change remote of your local clone to the one you’ve just copied `git remote set-url origin git@github.com:USER/REPO.git`. -4. Push your local clone to GitHub `git push -u origin master`. - -## Usage Examples - -- [Semantic for cynics](https://pepelsbey.net/pres/semantics/en/) -- [Inhuman UI](https://pepelsbey.net/pres/inhuman-ui/) -- [My Vanilla CSS](https://pepelsbey.net/pres/vanilla-css/) -- [I’m in IoT](https://pepelsbey.net/pres/im-in-iot/) +By doing this you would get a GitHub repo linked with Netlify in a way any change to the repo would trigger a Shower rebuild and deploy to Netlify servers, which allows for an easy way to create and share Shower presentation without the need to install anything locally. ## Browser Support @@ -74,7 +69,7 @@ Latest stable versions of Chrome, Edge, Firefox, and Safari are supported. 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). +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), [zloylos](https://github.com/zloylos), [shvaikalesh](https://github.com/shvaikalesh). --- Licensed under [MIT License](LICENSE.md).