diff --git a/README.md b/README.md index c9ad38e2d..e0be75a03 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,14 @@ If you're feeling curious. You can take a look at a more detailed architecture [ 3. Run `python3 test.py` -4. To measure the performance: `./server_test.sh` +## To Run + +### Without hot reloading +`python3 app.py` + +### With hot reloading +`python3 app.py --dev=true` + ## Contributors/Supporters diff --git a/docs/README.md b/docs/README.md index 5a56ae389..41a2d41e9 100644 --- a/docs/README.md +++ b/docs/README.md @@ -24,7 +24,7 @@ app = Robyn(__file__) async def h(): return "Hello, world!" -app.start() +app.start(port=5000) ``` diff --git a/docs/_sidebar.md b/docs/_sidebar.md index 4e97d20b1..723ccc42b 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -5,3 +5,4 @@ - [Architecture](architecture.md) - [Comparison](comparison.md) - [Plugins](plugins.md) +- [Future Roadmap](roadmap.md) diff --git a/docs/api.md b/docs/api.md index f2c859b0b..52f3dbeab 100644 --- a/docs/api.md +++ b/docs/api.md @@ -12,7 +12,7 @@ app = Robyn(__file__) async def h(): return "Hello, world!" -app.start() +app.start(port=5000, url="0.0.0.0") # url is optional, defaults to 127.0.0.1 ``` diff --git a/docs/comparison.md b/docs/comparison.md index 14583c9ed..ade23457b 100644 --- a/docs/comparison.md +++ b/docs/comparison.md @@ -16,6 +16,7 @@ I used [oha](https://github.com/hatoo/oha) to perform the testing of 10000 reque Average: 0.0586 secs Requests/sec: 850.3200 ``` + 2. FastAPI(Uvicorn) ``` Total: 12.4052 secs @@ -26,7 +27,6 @@ I used [oha](https://github.com/hatoo/oha) to perform the testing of 10000 reque ``` 3. Django(Gunicron) ``` - Success rate: 1.0000 Total: 24.9545 secs Slowest: 0.1587 secs Fastest: 0.0168 secs diff --git a/docs/landing_page/index.html b/docs/landing_page/index.html index 05b17cae4..dcb1496a7 100644 --- a/docs/landing_page/index.html +++ b/docs/landing_page/index.html @@ -230,7 +230,8 @@

A fast web framework!