Repository: litestar-org/litestar
Pull request #4138: docs: Some readme updates
Author: login: provinzkraut
Labels: name: pr/internal
name: size: small
name: area/docs
description: This PR involves changes to the documentation
name: type/docs
Created: 2025-04-22T17:45:16Z | Merged: 2025-04-24T17:09:48Z



Diff:
diff --git a/README.md b/README.md
index 503c0a15ae..ea3a35fa30 100644
--- a/README.md
+++ b/README.md
@@ -25,9 +25,9 @@
 <hr>
 
 Litestar is a powerful, flexible yet opinionated ASGI framework, focused on
-building APIs, and offers high-performance data validation and parsing,
-dependency injection, first-class ORM integration, authorization primitives, and much
-more that's needed to get applications up and running.
+building APIs. It offers high-performance data validation, dependency injection,
+first-class ORM integration, authorization primitives, a rich plugin API, middleware,
+and much more that's needed to get applications up and running.
 
 Check out the [documentation 📚](https://docs.litestar.dev/) for a detailed overview of
 its features!
@@ -61,22 +61,31 @@ can give you a good impression how a fully fledged Litestar application may look
 ```shell
 pip install litestar
 ```
+or to include the CLI and a server (uvicorn) for running your application:
+```shell
+pip install litestar[standard]
+```
 
 ## Quick Start
 
-```python
+```python title="app.py"
 from litestar import Litestar, get
 
-
 @get("/")
 async def hello_world() -> dict[str, str]:
     """Keeping the tradition alive with hello world."""
     return {"hello": "world"}
 
-
 app = Litestar(route_handlers=[hello_world])
 ```
 
+And run it with
+
+```bash
+litestar run
+```
+
+
 ## Core Features
 
 - [Class based controllers](#class-based-controllers)
@@ -86,7 +95,7 @@ app = Litestar(route_handlers=[hello_world])
 - [OpenAPI 3.1 schema generation](#openapi)
 - [Life Cycle Hooks](#request-life-cycle-hooks)
 - [Route Guards based Authorization](#route-guards)
-- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2](https://docs.pydantic.dev/latest/),
+- Support for `dataclasses`, `TypedDict`, [`msgspec`](https://jcristharif.com/msgspec/), [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
   [msgspec](https://github.com/jcrist/msgspec) and [attrs](https://www.attrs.org/en/stable/)
 - Layered parameter declaration
 - Support for [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457) standardized "Problem Detail" error responses
@@ -98,8 +107,7 @@ app = Litestar(route_handlers=[hello_world])
   - [Swagger-UI](https://swagger.io/tools/swagger-ui/)
 - [Trio](https://trio.readthedocs.io/en/stable/) support (built-in, via [AnyIO](https://anyio.readthedocs.io/))
 - Ultra-fast validation, serialization and deserialization using [msgspec](https://github.com/jcrist/msgspec)
-- SQLAlchemy integration
-- Piccolo ORM Support
+- [SQLAlchemy integration](https://docs.advanced-alchemy.litestar.dev/latest/)
 
 ## Example Applications
 
diff --git a/docs/PYPI_README.md b/docs/PYPI_README.md
index e3bb81c390..1030d8014d 100644
--- a/docs/PYPI_README.md
+++ b/docs/PYPI_README.md
@@ -22,9 +22,9 @@
 <hr>
 
 Litestar is a powerful, flexible yet opinionated ASGI framework, focused on
-building APIs, and offers high-performance data validation and parsing,
-dependency injection, first-class ORM integration, authorization primitives, and much
-more that's needed to get applications up and running.
+building APIs. It offers high-performance data validation, dependency injection,
+first-class ORM integration, authorization primitives, a rich plugin API, middleware,
+and much more that's needed to get applications up and running.
 
 Check out the [documentation 📚](https://docs.litestar.dev/) for a detailed overview of
 its features!
@@ -58,22 +58,31 @@ can give you a good impression how a fully fledged Litestar application may look
 ```shell
 pip install litestar
 ```
+or to include the CLI and a server (uvicorn) for running your application:
+```shell
+pip install litestar[standard]
+```
 
 ## Quick Start
 
-```python
+```python title="app.py"
 from litestar import Litestar, get
 
-
 @get("/")
 async def hello_world() -> dict[str, str]:
     """Keeping the tradition alive with hello world."""
     return {"hello": "world"}
 
-
 app = Litestar(route_handlers=[hello_world])
 ```
 
+And run it with
+
+```bash
+litestar run
+```
+
+
 ## Core Features
 
 - [Class based controllers](#class-based-controllers)
@@ -83,7 +92,7 @@ app = Litestar(route_handlers=[hello_world])
 - [OpenAPI 3.1 schema generation](#openapi)
 - [Life Cycle Hooks](#request-life-cycle-hooks)
 - [Route Guards based Authorization](#route-guards)
-- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2](https://docs.pydantic.dev/latest/),
+- Support for `dataclasses`, `TypedDict`, [`msgspec`](https://jcristharif.com/msgspec/), [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
   [msgspec](https://github.com/jcrist/msgspec) and [attrs](https://www.attrs.org/en/stable/)
 - Layered parameter declaration
 - Support for [RFC 9457](https://datatracker.ietf.org/doc/html/rfc9457) standardized "Problem Detail" error responses
@@ -95,8 +104,7 @@ app = Litestar(route_handlers=[hello_world])
   - [Swagger-UI](https://swagger.io/tools/swagger-ui/)
 - [Trio](https://trio.readthedocs.io/en/stable/) support (built-in, via [AnyIO](https://anyio.readthedocs.io/))
 - Ultra-fast validation, serialization and deserialization using [msgspec](https://github.com/jcrist/msgspec)
-- SQLAlchemy integration
-- Piccolo ORM Support
+- [SQLAlchemy integration](https://docs.advanced-alchemy.litestar.dev/latest/)
 
 ## Example Applications
 


Reviews:
user: login: euri10
state: COMMENTED
author_association: CONTRIBUTOR
submitted_at: 2025-04-24T15:46:35Z
user: login: provinzkraut
state: COMMENTED
author_association: MEMBER
submitted_at: 2025-04-24T15:53:37Z
user: login: euri10
state: APPROVED
author_association: CONTRIBUTOR
submitted_at: 2025-04-24T15:58:56Z

Review comments:
diff_hunk: @@ -86,7 +95,7 @@ app = Litestar(route_handlers=[hello_world])
 - [OpenAPI 3.1 schema generation](#openapi)
 - [Life Cycle Hooks](#request-life-cycle-hooks)
 - [Route Guards based Authorization](#route-guards)
-- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2](https://docs.pydantic.dev/latest/),
+- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
path: README.md
user: login: euri10
body: and msgspec ?
created_at: 2025-04-24T15:46:07Z
author_association: CONTRIBUTOR
diff_hunk: @@ -83,7 +92,7 @@ app = Litestar(route_handlers=[hello_world])
 - [OpenAPI 3.1 schema generation](#openapi)
 - [Life Cycle Hooks](#request-life-cycle-hooks)
 - [Route Guards based Authorization](#route-guards)
-- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2](https://docs.pydantic.dev/latest/),
+- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
path: docs/PYPI_README.md
user: login: euri10
body: msgspec too ?
created_at: 2025-04-24T15:46:30Z
author_association: CONTRIBUTOR
diff_hunk: @@ -86,7 +95,7 @@ app = Litestar(route_handlers=[hello_world])
 - [OpenAPI 3.1 schema generation](#openapi)
 - [Life Cycle Hooks](#request-life-cycle-hooks)
 - [Route Guards based Authorization](#route-guards)
-- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2](https://docs.pydantic.dev/latest/),
+- Support for `dataclasses`, `TypedDict`, [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
path: README.md
user: login: provinzkraut
body: ```suggestion
- Support for `dataclasses`, `TypedDict`, [`msgspec`](https://jcristharif.com/msgspec/), [pydantic version 1 and version 2 (even within the same application)](https://docs.pydantic.dev/latest/) and [(c)attrs](https://catt.rs/en/stable/)
```
created_at: 2025-04-24T15:53:37Z
author_association: MEMBER

PR comments:
user: login: github-actions[bot]
created_at: 2025-04-24T17:11:57Z
body: Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4138
author_association: NONE