From b829248e7dd035e401bbe72e89c546c905e1ca71 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 16 Oct 2018 16:10:24 +0100 Subject: [PATCH] Add feature list to README/docs --- README.md | 17 +++++++++++++---- docs/index.md | 17 +++++++++++++---- 2 files changed, 26 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9d1bef40..06d527f2 100644 --- a/README.md +++ b/README.md @@ -22,10 +22,19 @@ --- -Starlette is a lightweight [ASGI](https://asgi.readthedocs.io/en/latest/) framework/toolkit. +Starlette is a lightweight [ASGI](https://asgi.readthedocs.io/en/latest/) framework/toolkit, +which is ideal for building high performance asyncio services. -It is ideal for building high performance asyncio services, and supports both -HTTP and WebSockets. +It is production-ready, and gives you the following: + +* Seriously impressive performance. +* WebSocket support. +* In-process background tasks. +* Startup and shutdown events. +* Test client built on `requests`. +* CORS, GZip, Static Files, Streaming responses. +* 100% test coverage. +* 100% type annotated codebase. ## Requirements @@ -53,7 +62,7 @@ import uvicorn app = Starlette() @app.route('/') -def homepage(request): +asnyc def homepage(request): return JSONResponse({'hello': 'world'}) if __name__ == '__main__': diff --git a/docs/index.md b/docs/index.md index acd0ffbe..50dfdba6 100644 --- a/docs/index.md +++ b/docs/index.md @@ -21,10 +21,19 @@ # Introduction -Starlette is a lightweight [ASGI](https://asgi.readthedocs.io/en/latest/) framework/toolkit. +Starlette is a lightweight [ASGI](https://asgi.readthedocs.io/en/latest/) framework/toolkit, +which is ideal for building high performance asyncio services. -It is ideal for building high performance asyncio services, and supports both -HTTP and WebSockets. +It is production-ready, and gives you the following: + +* Seriously impressive performance. +* WebSocket support. +* In-process background tasks. +* Startup and shutdown events. +* Test client built on `requests`. +* CORS, GZip, Static Files, Streaming responses. +* 100% test coverage. +* 100% type annotated codebase. ## Requirements @@ -52,7 +61,7 @@ import uvicorn app = Starlette() @app.route('/') -def homepage(request): +async def homepage(request): return JSONResponse({'hello': 'world'}) if __name__ == '__main__':