Update README.md and refactor code base

Author: dormant-user

README.md

@@ -21,25 +21,31 @@ pip install "git+https://github.com/${repo}.git@${latest}"
 ## Usage
 
 ```python
-import fastapiauthenticator
+import fastapiauthenticator as api
 
 from fastapi import FastAPI
 
 app = FastAPI()
 
-
 @app.get("/public")
-def public_route():
+async def public_route():
     return {"message": "This is a public route"}
 
-
-def private_route():
+async def private_route():
     return {"message": "This is a private route"}
 
-
-fastapiauthenticator.Authenticator(app=app, secure_function=private_route)
+api.protect(
+    app=app,
+    params=api.Parameters(
+        path="/private",
+        function=private_route
+    )
+)
 ```
 
+> `FastAPIAuthenticator` supports both `APIRoute` and `APIWebSocketRoute` routes.<br>
+> Refer [samples] directory for different use-cases.
+
 ## Coding Standards
 Docstring format: [`Google`][google-docs] <br>
 Styling conventions: [`PEP 8`][pep8] and [`isort`][isort]
@@ -80,6 +86,7 @@ Licensed under the [MIT License][license]
 [google-docs]: https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings
 [pep8]: https://www.python.org/dev/peps/pep-0008/
 [isort]: https://pycqa.github.io/isort/
+[samples]: https://github.com/thevickypedia/FastAPIAuthenticator/tree/main/samples
 
 [label-pyversion]: https://img.shields.io/badge/python-3.11%20%7C%203.12-blue
 [label-platform]: https://img.shields.io/badge/Platform-Linux|macOS|Windows-1f425f.svg

verify/BaseAPI.md base/README.mdverify/BaseAPI.md renamed to base/README.md

@@ -42,7 +42,7 @@ def __init__(
 
         Args:
             app: FastAPI application instance to which the authenticator will be added.
-            params: Parameters for the secure routes, can be a single `Parameters` object or a list of `Parameters`.
+            params: Parameters for the secure routes can be a single `Parameters` object or a list of `Parameters`.
             timeout: Session timeout in seconds, default is 300 seconds (5 minutes).
             username: Username for authentication, can be set via environment variable 'USERNAME'.
             password: Password for authentication, can be set via environment variable 'PASSWORD'.

verify/base_api.py base/api.pyverify/base_api.py renamed to base/api.py

@@ -16,8 +16,9 @@ version = { attr = "fastapiauthenticator.version.version" }
 
 [project.optional-dependencies]
 dev = [
+    "websockets==15.0.*",
     "pre-commit==4.2.*",
-    "uvicorn==0.34.*"
+    "uvicorn==0.34.*",
 ]
 
 [build-system]