Skip to content

Commit

Permalink
readme uodate
Browse files Browse the repository at this point in the history
  • Loading branch information
konneki committed Jun 25, 2020
1 parent 7232411 commit 7ae7da4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 12 deletions.
19 changes: 8 additions & 11 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
![cover](https://cotenfrontend.pl/img/cover.png)
![cover](https://konneki.github.io/hydrapp/og.png)

# WTF Webpack Starter Kit
# Hydrapp

Simple toolkit for your static websites development.
Lets you count the amount of glasses to drink everyday.

## How to use it?

Click on `Use this template` button to generate a new repository based on this starter kit. After that clone it to your computer, go to the project directory in console and type `npm install`.
You can LMB on plus or minus signs to change value, or you can use +, up arrow or right arrow to increase value and -, down arrow or left arrow to decrese value. It is as simple as that.
Thanks to localStorage you can check your stats in time by date.
After opening menu you can clearly see a percentage indicator of drunk water. Aim for 15 cups!

## Available scripts

`npm run start` - runs development mode

`npm run build` - runs build process for production

`npm run publish` - runs build process and publish the page using `gh-pages` branch
## Mobile version coming soon!

And remember, stay hydrated!
2 changes: 1 addition & 1 deletion src/pages/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
<!-- full url to the image with http(s) ie. https://maciejkorsan.github.io/my-repo/assets/img/fb.png. Facebook suggests at least 1200 x 630. -->
<meta
property="og:image"
content="https://konneki.github.io/hydrapp/public/og.png"
content="https://konneki.github.io/hydrapp/og.png"
/>

<!-- uncomment the line below to enable PWA -->
Expand Down

0 comments on commit 7ae7da4

Please sign in to comment.