From 6b51660f29f6b27e08d33f3e73feec92404bbfe9 Mon Sep 17 00:00:00 2001 From: "Yuhesh Pandian.P.J" Date: Mon, 1 Jan 2024 19:52:36 +0530 Subject: [PATCH] =?UTF-8?q?=E2=AC=86=EF=B8=8F=20Update=20README.rst?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added some improvement on the content of README.rst --- README.rst | 48 ++++++++++++++++++++++++------------------------ 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/README.rst b/README.rst index eab9f25d..5f513b20 100644 --- a/README.rst +++ b/README.rst @@ -1,15 +1,15 @@ -Flask +**Flask** ===== -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 -complex applications. It began as a simple wrapper around `Werkzeug`_ -and `Jinja`_ and has become one of the most popular Python web -application frameworks. +**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 +complex applications. It began as a simple **wrapper** around `Werkzeug`_ +and `Jinja`_ and has become one of the most popular **Python Web +Application Frameworks**. -Flask offers suggestions, but doesn't enforce any dependencies or -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 +**Flask** offers suggestions, but doesn't enforce any *dependencies or +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 community that make adding new functionality easy. .. _WSGI: https://wsgi.readthedocs.io/ @@ -17,10 +17,10 @@ community that make adding new functionality easy. .. _Jinja: https://jinja.palletsprojects.com/ -Installing +**Installing** ---------- -Install and update using `pip`_: +**Install & Update** using `pip`_: .. code-block:: text @@ -29,7 +29,7 @@ Install and update using `pip`_: .. _pip: https://pip.pypa.io/en/stable/getting-started/ -A Simple Example +**A Simple Example** ---------------- .. code-block:: python @@ -49,19 +49,19 @@ A Simple Example * 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 -contribution to Flask, see the `contributing guidelines`_. +For guidance on setting up a *development environment* and how to make a +*contribution* to ``Flask``, see the `contributing guidelines`_. .. _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 allow the maintainers to devote more time to the projects, `please donate today`_. @@ -69,15 +69,15 @@ donate today`_. .. _please donate today: https://palletsprojects.com/donate -Links +**Links** ----- -- Documentation: https://flask.palletsprojects.com/ -- Changes: https://flask.palletsprojects.com/changes/ -- PyPI Releases: https://pypi.org/project/Flask/ -- Source Code: https://github.com/pallets/flask/ -- Issue Tracker: https://github.com/pallets/flask/issues/ -- Chat: https://discord.gg/pallets +- **Documentation**: https://flask.palletsprojects.com/ +- **Changes**: https://flask.palletsprojects.com/changes/ +- **PyPI Releases**: https://pypi.org/project/Flask/ +- **Source Code**: https://github.com/pallets/flask/ +- **Issue Tracker**: https://github.com/pallets/flask/issues/ +- **Chat**: https://discord.gg/pallets ~~~~~