From a0628f3f6f8501ed4abe6c3b92d682253c6c3ffb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebasti=C3=A1n=20Ram=C3=ADrez?= Date: Fri, 21 Dec 2018 16:32:09 +0400 Subject: [PATCH] :memo: Update docs to improve look in GitHub --- README.md | 10 +++++++--- docs/index.md | 10 +++++++--- 2 files changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 2d743b52a..d5cac0ea0 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,8 @@ $ pip install uvicorn ## Example +### Create it + * Create a file `main.py` with: ```Python @@ -109,7 +111,9 @@ If you don't know, check the _"In a hurry?"_ section about operations. +* Both _paths_ take `GET` operations (also known as HTTP _methods_). * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`. -* The _path_ `/items/{item_id}` has an optional _query parameter_ `q` that is a `str`. +* The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`. ### Interactive API docs diff --git a/docs/index.md b/docs/index.md index 2d743b52a..d5cac0ea0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -65,6 +65,8 @@ $ pip install uvicorn ## Example +### Create it + * Create a file `main.py` with: ```Python @@ -109,7 +111,9 @@ If you don't know, check the _"In a hurry?"_ section about operations. +* Both _paths_ take `GET` operations (also known as HTTP _methods_). * The _path_ `/items/{item_id}` has a _path parameter_ `item_id` that should be an `int`. -* The _path_ `/items/{item_id}` has an optional _query parameter_ `q` that is a `str`. +* The _path_ `/items/{item_id}` has an optional `str` _query parameter_ `q`. ### Interactive API docs