Docs fix

sparckles · Sep 21, 2021 · 6734482 · 6734482
1 parent 07597fa
commit 6734482
Show file tree

Hide file tree

Showing 8 changed files with 22 additions and 16 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -230,7 +230,8 @@ <h1>A fast web framework!</h1>
           <div class="col-12 text-center">
             <ul class="list-inline">
               <li class="list-inline-item">
-                <a href="https://github.com/sansyrox/robyn/blob/main/test.py"
+                <a
+                  href="https://github.com/sansyrox/robyn/blob/main/test_python/base_routes.py"
                   >Test Drive</a
                 >
               </li>

diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -0,0 +1,8 @@
+## Future Roadmap
+
+- Integrate actix router 
+- Integrate WebSockets
+- Reveal Logo
+- Add session/cookie plugins
+- Add the plugin documentation
+
diff --git a/test_dir/build/index.html b/test_dir/build/index.html