Update README.md

baramex · Aug 25, 2021 · 811b849 · 811b849
1 parent db3ef95
commit 811b849
Showing 1 changed file with 48 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,48 @@
-# flashes-messages-js
-Generate flashes messages on html with javascript
+## Infos
+[![](https://img.shields.io/github/languages/top/baramex/flashes-messages-js?style=for-the-badge)]()
+
+[![](https://img.shields.io/github/downloads/baramex/flashes-messages-js/total.svg?style=for-the-badge)](https://github.com/baramex/flashes-messages-js/releases/)
+[![](https://img.shields.io/github/v/release/baramex/flashes-messages-js?style=for-the-badge&label=last%20release)](https://github.com/baramex/flashes-messages-js/releases/latest/)
+[![](https://img.shields.io/github/release-date/baramex/flashes-messages-js.svg?style=for-the-badge&label=last%20release%20date)](https://github.com/baramex/flashes-messages-js/releases/latest/)
+
+[![](https://img.shields.io/github/license/baramex/flashes-messages-js.svg?style=for-the-badge)](https://choosealicense.com/licenses/lgpl-3.0/)
+[![](https://img.shields.io/badge/author-baramex-red?style=for-the-badge)](https://github.com/baramex/)
+
+## Requirements
+- [jQuery](https://code.jquery.com/)
+
+## Installation
+- Download the script and use in local OR use CDN
+
+## Create Flash
+- function: createFlash(type, message, time?)
+- types: 
+- - `success-flash` <img width='70%' src='https://user-images.githubusercontent.com/47333747/130810606-c2b6d990-d224-41aa-a70a-d647a283f000.PNG'>
+- - `error-flash` <img width='70%' src='https://user-images.githubusercontent.com/47333747/130810630-6f26c84b-37fe-46fd-bf3f-88ef63ca1da1.PNG'>
+- - `info-flash` <img width='70%' src='https://user-images.githubusercontent.com/47333747/130810660-0cc2aa75-329d-42ac-9bd7-37ed6aca08bc.PNG'>
+- - `not-allowed-flash` <img src='https://user-images.githubusercontent.com/47333747/130810671-8124093c-14fa-405c-82f2-ae46e9237736.PNG' width='70%'>
+- message: string
+- time: the default is 2500 ms, 0 is infinite
+- <i>exemple: createFlash("success-flash", "You understood!", 0)</i>
+
+## CDN
+```html
+<link rel="stylesheet" href="http://baramex.fr:9999/cdn/flashes-messages/flashs.css">
+<script src="http://baramex.fr:9999/cdn/flashes-messages/flashs.js"></script>
+```
+
+## Exemple
+Head:
+```html
+<script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
+
+<link rel="stylesheet" href="http://baramex.fr:9999/cdn/flashes-messages/flashs.css">
+<script src="http://baramex.fr:9999/cdn/flashes-messages/flashs.js"></script>
+```
+
+Body:
+```html
+<body onload="createFlash('info-flash', 'loaded!');">
+
+</body>
+```