Skip to content

Commit 1702d43

Browse files
GStaehlerGStaehler
committed
Update README
1 parent c1e5b3f commit 1702d43

3 files changed

Lines changed: 21 additions & 20 deletions

File tree

‎README.md‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[![GitHub file size in bytes](https://img.shields.io/github/size/GStaehler/Window_Engine/dist/window-engine.min.js.svg?color=green&label=window-engine.min.js)](https://github.com/GStaehler/Window-Engine/blob/master/dist/window-engine.min.js)
77
[![GitHub file size in bytes](https://img.shields.io/github/size/GStaehler/Window_Engine/dist/window-engine.min.css.svg?color=green&label=window-engine.min.css)](https://github.com/GStaehler/Window-Engine/blob/master/dist/window-engine.css)
88
[![CodeFactor](https://www.codefactor.io/repository/github/gstaehler/window-engine/badge)](https://www.codefactor.io/repository/github/gstaehler/window-engine)
9-
![npm](https://img.shields.io/npm/dw/window-engine)
9+
[![npm](https://img.shields.io/npm/dw/window-engine)](https://www.npmjs.com/package/window-engine)
1010

1111
![Demo](https://gstaehler.github.io/window_engine/window.png)
1212

@@ -24,15 +24,15 @@ Download ZIP :
2424
```
2525

2626
OR Install with NPM :
27-
```html
27+
```sh
2828
npm i window-engine
2929
```
3030

3131
OR Test it first :
3232

3333
```html
34-
<link rel="stylesheet" href="https://unpkg.com/window-engine@4.3.5/dist/window-engine.min.css">
35-
<script src="https://unpkg.com/window-engine@4.3.5/dist/window-engine.min.js"></script> // End of your file
34+
<link rel="stylesheet" href="https://unpkg.com/window-engine@latest/dist/window-engine.min.css">
35+
<script src="https://unpkg.com/window-engine@latest/dist/window-engine.min.js"></script> // End of your file
3636
```
3737

3838
&nbsp;
@@ -47,19 +47,19 @@ OR Test it first :
4747
<div class="mainWindow">Content</div>
4848
</div>
4949
```
50-
*! is the number of the window*
50+
**!** *is the number of the window*
5151

52-
*color is the color of the window : purple, orange, brown, cyan, crimson, green*
52+
**color** *is the color of the window : purple, orange, brown, cyan, crimson, green*
5353

54-
*if no color, the window is black*
54+
*default color is black*
5555

5656
&nbsp;
5757

5858
### Add a new window
5959

60-
To add a new window, copy the structure above in your html and change ! (if this is your third window, ! = 3 for example)
60+
To add a new window, copy the structure above in your html and change **!** (if this is your third window, **!** = 3 for example)
6161

62-
You can add another button to open you new window :
62+
Add another button to open you new window :
6363

6464
```html
6565
<button id="button!"></button>
@@ -69,7 +69,7 @@ You can add another button to open you new window :
6969

7070
### windowGroup
7171

72-
All of the windows must be in one windowGroup :
72+
All of the windows must be in the same windowGroup :
7373

7474
```html
7575
<div class="windowGroup"> Your windows ... </div>
@@ -79,7 +79,7 @@ All of the windows must be in one windowGroup :
7979

8080
### Fade effect
8181

82-
You can add a fade effect on the windows with the class "fade" :
82+
Add a fade effect on the windows with the class "fade" :
8383

8484
```html
8585
<div id="window!" class="window fade">
@@ -89,13 +89,13 @@ You can add a fade effect on the windows with the class "fade" :
8989

9090
### Display
9191

92-
If you want your window to be visible without clicking on a button the first time :
92+
The following code makes the window visible without a button click :
9393

9494
```html
9595
<div id="window!" class="window" style="display: initial;">
9696
```
9797

98-
Of course you can combine it with the fade effect :
98+
Of course it is possible to combine it with the fade effect :
9999

100100
```html
101101
<div id="window!" class="window fade" style="display: initial;">
@@ -105,7 +105,7 @@ Of course you can combine it with the fade effect :
105105

106106
### Size
107107

108-
You can change the size of the window with "small" and "large" :
108+
Change the size of the window with "small" and "large" :
109109

110110
```html
111111
<div id="window!" class="window large">

‎example/index.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<head>
55
<meta charset="utf-8">
66
<meta name="author" content="Gauthier Staehler">
7-
<meta name="description" content="Window Engine is a lightweight javascript library for draggable and beautiful windows">
7+
<meta name="description" content="Lightweight and touchscreen friendly zero-dependency JavaScript library for draggable windows">
88
<meta name="keywords" content="JavaScript, CSS, Window, Draggable">
99
<title>Window Engine - JavaScript Library</title>
1010
<link rel="stylesheet" href="demo.css">
@@ -14,7 +14,7 @@
1414
<body>
1515

1616
<header>
17-
<p>Window Engine 4.3.6</p>
17+
<p>Window Engine 4.3.7</p>
1818
</header>
1919

2020
<div class="windowGroup">
@@ -27,7 +27,7 @@
2727
</div>
2828
<div class="mainWindow">
2929
<p>Welcome to Window Engine !</p>
30-
<p>Window Engine helps you start projects that need draggable and beautiful custom windows.</p>
30+
<p>Window Engine helps you start projects that need draggable windows.</p>
3131
</div>
3232
</div>
3333

‎package.json‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "window-engine",
3-
"version": "4.3.6",
4-
"description": "Lightweight and touchscreen friendly js library for draggable windows",
3+
"version": "4.3.7",
4+
"description": "Lightweight and touchscreen friendly zero-dependency JavaScript library for draggable windows",
55
"main": "dist/window-engine.min.js",
66
"unpkg": "dist/window-engine.min.js",
77
"files": [
@@ -19,7 +19,8 @@
1919
"keywords": [
2020
"draggable",
2121
"window",
22-
"modals"
22+
"modals",
23+
"engine"
2324
],
2425
"author": "Gauthier Staehler",
2526
"license": "MIT",

0 commit comments

Comments
 (0)