Improve README.md structure and clarity for better onboarding
This commit is contained in:
parent
b78b5a210b
commit
a210f53c1f
1 changed files with 31 additions and 21 deletions
52
README.md
52
README.md
|
|
@ -1,19 +1,26 @@
|
||||||
# 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 grown into one of the most popular Python web
|
||||||
application frameworks.
|
frameworks in the world.
|
||||||
|
|
||||||
Flask offers suggestions, but doesn't enforce any dependencies or
|
Flask provides a minimal core with no enforced project layout, allowing
|
||||||
project layout. It is up to the developer to choose the tools and
|
developers to choose the tools and libraries they prefer. Its flexibility
|
||||||
libraries they want to use. There are many extensions provided by the
|
makes it an excellent choice for both small projects and enterprise-grade
|
||||||
community that make adding new functionality easy.
|
applications.
|
||||||
|
|
||||||
[WSGI]: https://wsgi.readthedocs.io/
|
[WSGI]: https://wsgi.readthedocs.io/
|
||||||
[Werkzeug]: https://werkzeug.palletsprojects.com/
|
[Werkzeug]: https://werkzeug.palletsprojects.com/
|
||||||
[Jinja]: https://jinja.palletsprojects.com/
|
[Jinja]: https://jinja.palletsprojects.com/
|
||||||
|
|
||||||
|
## Why Flask?
|
||||||
|
|
||||||
|
- Minimal by design – no rigid structure, full freedom of choice.
|
||||||
|
- Scalable from small scripts to large applications.
|
||||||
|
- Extensible through a rich ecosystem of extensions.
|
||||||
|
- Backed by strong documentation and a large, active community.
|
||||||
|
|
||||||
## A Simple Example
|
## A Simple Example
|
||||||
|
|
||||||
|
|
@ -35,17 +42,20 @@ $ flask run
|
||||||
|
|
||||||
## Donate
|
## Donate
|
||||||
|
|
||||||
The Pallets organization develops and supports Flask and the libraries
|
The Pallets organization maintains Flask and its ecosystem.
|
||||||
it uses. In order to grow the community of contributors and users, and
|
To help grow the community and support long-term development,
|
||||||
allow the maintainers to devote more time to the projects, [please
|
[please consider donating today].
|
||||||
donate today].
|
|
||||||
|
|
||||||
[please donate today]: https://palletsprojects.com/donate
|
[please consider donating today]: https://palletsprojects.com/donate
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
See our [detailed contributing documentation][contrib] for many ways to
|
Flask welcomes all types of contributions, including:
|
||||||
contribute, including reporting issues, requesting features, asking or answering
|
- Reporting bugs or proposing improvements
|
||||||
questions, and making PRs.
|
- Discussing or suggesting features
|
||||||
|
- Improving the documentation
|
||||||
|
- Reviewing or submitting pull requests
|
||||||
|
|
||||||
[contrib]: https://palletsprojects.com/contributing/
|
To get started, see our [contributing guide][contrib].
|
||||||
|
|
||||||
|
[contrib]: https://palletsprojects.com/contributing/
|
||||||
Loading…
Add table
Add a link
Reference in a new issue