Merge pull request #53 from Milad75Rasouli/51-readmemd2

51 readmemd2
milad-rasouli · Jun 25, 2024 · 3fbcb64 · 3fbcb64
2 parents de69833 + f2a465e
commit 3fbcb64
Showing 1 changed file with 19 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,21 @@ Portfolio aims for you to have your personal weblog. It contains the following p
 3. **About Me Page:** A detailed section where you can write more about yourself.
 4. **Contact Page:** A communication channel where others can write direct messages to you as an admin.
 
-[Here is where you can see how my plans for the project.](https://github.com/users/Milad75Rasouli/projects/5) If you have any suggestions to enhance this project, please feel free to open an issue.
+[Here is where you can see my plans for the project.](https://github.com/users/Milad75Rasouli/projects/5) If you have any suggestions to enhance this project, please feel free to open an issue.
+
+## Endpoints Table
+
+| No. | Route         | Description                                                     |
+| --- | ------------- | --------------------------------------------------------------- |
+| 1   | /             | Landing page                                                    |
+| 2   | /about-me     | About me section where you’ll find information about the author |
+| 3   | /blog         | Blog list: view a list of blogs                                 |
+| 4   | /blog/:ID     | Blog section: view the content of an individual blog            |
+| 5   | /contact      | Contact form: leave a message for the author                    |
+| 6   | /user/sign-in | Sign-in page for users                                          |
+| 7   | /user/sign-up | Sign-up page for users                                          |
+| 8   | /admin        | Control panel page for managing blogs, users, and contacts      |
+| 9   | /health       | Check if the pod is running or not                              |
 
 ## How To Run It
 
@@ -63,8 +77,10 @@ Portfolio aims for you to have your personal weblog. It contains the following p
 ```bash
 git clone --recursive https://github.com/milad75rasouli/portfolio
 ```
+
 > [!NOTE]
-> if you clone the project without its submodules please run this you get them ```git submodule update --init --recursive ```
+> if you clone the project without its submodules please run this you get them `git submodule update --init --recursive `
+
 - Get the packages:
 
 ```bash
@@ -116,4 +132,4 @@ Then, visit the displayed address in your browser.
 
 ## Contribution
 
-Your contributions to this project are welcome. Please feel free to open issues and send pull requests.
+Your contributions to this project are welcome. Please feel free to open issues and send pull requests.