From e1ed0f0a45cd898e460cbf3a598ba6728b0bb96e Mon Sep 17 00:00:00 2001
From: Mobina <nimobina99@gmail.com>
Date: Fri, 28 Oct 2022 16:53:58 -0700
Subject: [PATCH] update Readme.md

---
 README.md | 106 ++++++++++++++++++++++++++++++++++++++++++++----------
 1 file changed, 88 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 43bb109..741271d 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,90 @@
-# news website
-This is a news website project that includes :
-- the display of news
-    - breaking news 
-    - the most visited news
-    - the most commented news
-    - the page of each news
-- categories
+# Online News site
 
-- user permissions
-- edit and delete users
--  web setting
- 
- 
- This project has three main parts: 
-  - admin panel
-  - authentication 
-  - the main part of the news site.
 
-And it is possible to register and login.
\ No newline at end of file
+## Table of Contents
+* [General Info](#general-information)
+* [Technologies Used](#technologies-used)
+* [Features](#features)
+* [Screenshots](#screenshots)
+* [Setup](#setup)
+* [Project Status](#project-status)
+* [Contact](#contact)
+
+
+
+## General Information
+An online news site that includes the latest news, news categories and breaking news with an advanced admin panel.
+
+## Technologies Used
+- PHP 8.1.10
+
+
+
+## Features
+List the ready features here:
+- Breaking News
+- Editor's Choice
+- Controversial News
+- User Permissions
+- Web Setting
+- Authentication
+
+
+## Screenshots
+![online news screenshot](./public/screenshots/Screenshot%20online%20news%20(2).png)
+
+![online news screenshot](./public/screenshots/Screenshot%20online%20news.png)
+
+![adminPanel screenshot](./public/screenshots/Screenshot%20Panel.png)
+
+![online news posts screenshot](./public/screenshots/Screenshot%20Posts.png)
+
+![RegisterPage screenshot](./public/screenshots/Screenshot%20Register.png)
+
+## Setup
+
+1. Install XAMPP or WAMPP
+
+2. Open XAMPP Control panal and start [apache] and [mysql] .
+
+3. Download project from github(https://github.com/MobinaJafarian/OnlineNewsSite)  
+    OR follow gitbash commands
+    
+    i>cd C:\\xampp\htdocs\
+    
+    ii>git clone https://github.com/MobinaJafarian/OnlineNewsSite.git
+    
+4. extract files in C:\\xampp\htdocs\.
+
+5. open link localhost/phpmyadmin
+
+6. click on new at side navbar.
+
+7. give a database name as (news-project) hit on create button.
+
+8. after creating database name click on import.
+
+9. browse the file in directory
+[NewsProject/database/news-project.sql].
+
+10. after importing successfully.
+
+11. open any browser and type http://localhost/NewsProject/
+
+12. first register and then login
+
+13. admin login details: 
+- Email=nj@gmail.com and 
+- Password=19991999
+
+
+
+
+## Project Status
+Project is:  _complete_
+
+
+
+
+## Contact
+Created by [@MobinaJafarian](https://github.com/MobinaJafarian) - feel free to contact me!