docs: add projects description

BrianMwevi · Jun 21, 2022 · 84d2a46 · 84d2a46
1 parent d20ee06
commit 84d2a46
Showing 1 changed file with 11 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,18 @@
-## Awwwards clone
+## Wakanda Community
 
 ### Description
 
-A basic Awwwards website API that includes user authentication system, posting of projects, rating, and performing CRUD operations on their projects. The application front-end is built with Angular <br>
-Live API: https://awwwards-cloned.herokuapp.com/api/ <br>
-Live Frontend: https://brianmwevi.github.io/awwwards-cloned/
+A web application where users can signup, login, logout, create posts, and neighborhoods. 
+
+Live API: https://wakanda-community.herokuapp.com/api/ <br>
+Live Frontend: https://brianmwevi.github.io/wakanda-frontend/
 
 ### Technologies Used
 
 - Python
 - Django
 - Django Rest Framework
+- Angular
 
 ### Prerequisites
 - git
@@ -19,8 +21,8 @@ Live Frontend: https://brianmwevi.github.io/awwwards-cloned/
 
 ### Setup Instructions and Installation
 - In your preferred location in your file system, create a virtual environment and activate it
-- Launch your terminal and paste the following command: `git clone https://github.com/BrianMwevi/awwwards-clone.git`
-- Change directory to awwwards-clone `cd awwwards-clone`
+- Launch your terminal and paste the following command: `git clone https://github.com/BrianMwevi/wakanda-community.git`
+- Change directory to wakanda-community `cd wakanda-community`
 - Open the project with your preferred IDE and run the following command in the terminal: `pip install -r requirements.txt`
 - Create variables in the .env file:
 - Run the application by typing the following in the terminal: `python manage.py runserver`
@@ -41,7 +43,7 @@ To fix a bug or modules enhancement, follow these steps:
 
 ### Known Bugs
 
-If you find any bug, open an issue [here](https://github.com/BrianMwevi/awwwards-clone/issues) by including your search query and the expected result.
+If you find any bug, open an issue [here](https://github.com/BrianMwevi/wakanda-community/issues) by including your search query and the expected result.
 
 
 ### License
@@ -52,7 +54,7 @@ Author: Brian Mwevi <br>
 Email: mwevibrian@gmail.com <br>
 Twitter: @brianmwevi <br>
 Github: github.com/brianmwevi <br>
-[Read More](https://github.com/BrianMwevi/awwwards-clone/blob/develop/LICENSE)
+[Read More](https://github.com/BrianMwevi/wakanda-community/blob/develop/LICENSE)
 
 
-[Go Back To Top](#awwwards-clone)
+[Go Back To Top](#wakanda-community)