licence and readme

Author: odilxon

LICENCE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Odya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

readme.md

@@ -1,25 +1,74 @@
 # Flask-HTML
-HTML generator for Flask applications.
+![Flask](https://img.shields.io/static/v1?label=under&message=Development&color=yellow&logo=flask)
+![GitHub top language](https://img.shields.io/github/languages/top/Odya-LLC/flask_html)
+![LICENCE](https://img.shields.io/github/license/Odya-LLC/flask_html)
+![Odya](https://img.shields.io/static/v1?label=Developed_by&message=Odya&color=green&logo=python)
 
+
+
+HTML generator for Flask applications. Make your HTML code more readable and easier to maintain.
 ## Installation
 ```bash
-pip install git+https://github.com/Odya-LLC/flask_html.git@main
+pip install flask_html
 ```
 
 ## Usage
 ```python
 from flask_html import Page, Head
 from flask_html.tags import Style, Body, Div, P
+from flask import request
 @app.route('/')
 def index():
-    head = Head('Title', ['link to css'],['link to js'], [{"meta property": "value"}])
+    head = Head('Title', [],['https://code.jquery.com/jquery-3.6.1.min.js'], [{"meta_property": "value"}])
     page = Page(head)
+    page.register_js("""
+                    $(document).ready(function(){
+                        $("body").append("<p>hello world</p>");
+                    })
+                     
+                     """)
     body = Body(page, styles=Style(color="red", padding_top="15px"),classes=['class1', 'class2'], id='body_id',elements=[
         Div(styles=Style(margin="10px"), classes=['class1', 'class2'], id='div_id', elements=[
             P(styles=Style(color="blue"), classes=['class1', 'class2'], id='p_id', elements=[
                 "Hello World"
             ])
         ])
     ])
-    return page.render(body)
+    return page.render(body, request)
 ```
+
+## Elements
+
+### Example of Div elements
+```python
+"""Div HTML element
+
+Args:
+    styles (Style, optional): Inline css styles. Defaults to None.
+    classes (List[str], optional): List of class names. Defaults to [].
+    id (str, optional): Unique ID. Defaults to None.
+    elements (List[object], optional): List of child elements. Defaults to [].
+    props (Dict[str, str], optional): Additional tag properties. Defaults to {}.
+"""
+Div(styles=None, classes=[], id=None, elements=[], props={})
+```
+### All elements
+
+ - Div
+ - P
+ - B
+ - H1-H6
+ - A
+ - Img
+ - Span
+ - Ul
+ - Li
+ - Button
+ - Input
+ - Form
+ - Header
+ - Footer
+ - Nav
+
+## License
+This project is licensed under the MIT License (see the `LICENSE` file for details).