⬆️ Update README.rst

Added some improvement on the content of README.rst
This commit is contained in:
Yuhesh Pandian.P.J 2024-01-01 19:52:36 +05:30 committed by GitHub
parent e33c3d4dfb
commit 6b51660f29
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,15 +1,15 @@
Flask **Flask**
===== =====
Flask is a lightweight `WSGI`_ web application framework. It is designed **Flask** is a *lightweight* `WSGI`_ *web application framework*. It is designed
to make getting started quick and easy, with the ability to scale up to to make getting started **quick and easy**, with the ability to scale up to
complex applications. It began as a simple wrapper around `Werkzeug`_ complex applications. It began as a simple **wrapper** around `Werkzeug`_
and `Jinja`_ and has become one of the most popular Python web and `Jinja`_ and has become one of the most popular **Python Web
application frameworks. Application Frameworks**.
Flask offers suggestions, but doesn't enforce any dependencies or **Flask** offers suggestions, but doesn't enforce any *dependencies or
project layout. It is up to the developer to choose the tools and project layout*. It is up to the **developer** to choose the *tools and
libraries they want to use. There are many extensions provided by the libraries* they want to use. There are many ``extensions`` provided by the
community that make adding new functionality easy. community that make adding new functionality easy.
.. _WSGI: https://wsgi.readthedocs.io/ .. _WSGI: https://wsgi.readthedocs.io/
@ -17,10 +17,10 @@ community that make adding new functionality easy.
.. _Jinja: https://jinja.palletsprojects.com/ .. _Jinja: https://jinja.palletsprojects.com/
Installing **Installing**
---------- ----------
Install and update using `pip`_: **Install & Update** using `pip`_:
.. code-block:: text .. code-block:: text
@ -29,7 +29,7 @@ Install and update using `pip`_:
.. _pip: https://pip.pypa.io/en/stable/getting-started/ .. _pip: https://pip.pypa.io/en/stable/getting-started/
A Simple Example **A Simple Example**
---------------- ----------------
.. code-block:: python .. code-block:: python
@ -49,19 +49,19 @@ A Simple Example
* Running on http://127.0.0.1:5000/ (Press CTRL+C to quit) * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
Contributing **Contributing**
------------ ------------
For guidance on setting up a development environment and how to make a For guidance on setting up a *development environment* and how to make a
contribution to Flask, see the `contributing guidelines`_. *contribution* to ``Flask``, see the `contributing guidelines`_.
.. _contributing guidelines: https://github.com/pallets/flask/blob/main/CONTRIBUTING.rst .. _contributing guidelines: https://github.com/pallets/flask/blob/main/CONTRIBUTING.rst
Donate **Donate**
------ ------
The Pallets organization develops and supports Flask and the libraries The **Pallets** organization develops and supports ``Flask`` and the *libraries*
it uses. In order to grow the community of contributors and users, and it uses. In order to grow the community of contributors and users, and
allow the maintainers to devote more time to the projects, `please allow the maintainers to devote more time to the projects, `please
donate today`_. donate today`_.
@ -69,15 +69,15 @@ donate today`_.
.. _please donate today: https://palletsprojects.com/donate .. _please donate today: https://palletsprojects.com/donate
Links **Links**
----- -----
- Documentation: https://flask.palletsprojects.com/ - **Documentation**: https://flask.palletsprojects.com/
- Changes: https://flask.palletsprojects.com/changes/ - **Changes**: https://flask.palletsprojects.com/changes/
- PyPI Releases: https://pypi.org/project/Flask/ - **PyPI Releases**: https://pypi.org/project/Flask/
- Source Code: https://github.com/pallets/flask/ - **Source Code**: https://github.com/pallets/flask/
- Issue Tracker: https://github.com/pallets/flask/issues/ - **Issue Tracker**: https://github.com/pallets/flask/issues/
- Chat: https://discord.gg/pallets - **Chat**: https://discord.gg/pallets
~~~~~ ~~~~~