updated readme

DonyaElbanna · Jan 4, 2023 · dd46829 · dd46829
1 parent ce979c0
commit dd46829
Show file tree

Hide file tree

Showing 6 changed files with 35 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,41 @@
 
 This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
 
+## Description
+
+A responsive react app inspired by this [Freecodecamp Article](https://www.freecodecamp.org/news/react-js-project-build-a-rick-and-morty-character-wiki/).
+
+It's a wiki app using the [Rick and Morty Api](https://rickandmortyapi.com/) to filter through the show's characters, episodes and locations, taking care of empty data (locations with no residents and filters with no matching characters).
+
+## Technologies used
+
+- [React](https://reactjs.org/)
+- [React Hooks](https://reactjs.org/docs/hooks-intro.html)
+- [Material UI](https://mui.com/material-ui/)
+- [React-router-dom](https://reactrouter.com/en/main)
+
+## Demo
+
+#### Home Page
+
+![Home Page](/demo/wiki-c.PNG.PNG)
+
+#### Characters Page
+
+![ Characters Page](/demo/wiki-c.PNG.PNG)
+
+#### Locations Page
+
+![ Locations Page](/demo/wiki-l.PNG.PNG)
+
+#### To Top button & Pagination
+
+![To Top button & Pagination](/demo/wiki-u.PNG)
+
+#### Mobile View
+
+![Mobile View](/demo/wiki-m.PNG)
+
 ## Available Scripts
 
 In the project directory, you can run:

diff --git a/demo/wiki-c.PNG b/demo/wiki-c.PNG
diff --git a/demo/wiki-e.PNG b/demo/wiki-e.PNG
diff --git a/demo/wiki-l.PNG b/demo/wiki-l.PNG
diff --git a/demo/wiki-m.PNG b/demo/wiki-m.PNG
diff --git a/demo/wiki-u.PNG b/demo/wiki-u.PNG