Update README.md

README.md

@@ -7,24 +7,67 @@
 Maya - Visualising the Climate-Water Connection for Specialists.
 </h1>
 
-# Project Overview
+## Overview
+Maya is a transformative web-based platform designed to address the critical challenge of water scarcity exacerbated by climate change. By converting complex environmental data into accessible, design-driven narratives, Maya empowers local stakeholders, international donors, and the broader community with actionable insights. This React-based application uses Gatsby to build a robust website and app framework.
 
-This project, named "Maya", aims to transform understanding with information and data. It's a React-based application that uses Gatsby for building the website and app.
+### Project Structure
+- **src/data/**: Contains JavaScript files with essential data and a `geojsonData/` subdirectory for GeoJSON data of various localities.
+- **src/images/**: Hosts images used across the application.
+- **src/pages/**: Includes main components of the application, each corresponding to different features or pages of the app:
+  - **Localities/**: Features interactive points for localities.
+  - **MainConsolidation/**: Contains the `App.js`, which is the main application file.
+  - **Maps/**: Stores map-related components like `BaseMap.js` and `TownBorderMap.js`.
 
-The project is structured into several main parts:
+## Background
+After extensive research and local engagement in Lebanon, Maya was developed to streamline the communication of intricate water case studies across the Levant. This initiative moves beyond traditional lengthy reports, using design to succinctly communicate the complexities of climate change. The project has demonstrated significant impact, having been effectively utilized in pitches to international donors.
 
-- `src/data/`: This directory contains JavaScript files with data that the application uses. It also includes a `geojsonData/` subdirectory with GeoJSON data for different localities.
+### Key Achievements
+- **Initial Testing**: Successfully tested by a local NGO during an international donor pitch.
+- **Collaborative Expansion**: Supported by recommendations from The Arab Reform Institute for expansion across the Levant.
+- **Sustainable Development Goals**: Aligned with UNSDG6, Maya focuses on sustainable management of water and sanitation for all.
 
-- `src/images/`: This directory contains images used throughout the application.
+## Installation
+To set up the Maya project locally, follow these steps:
+```bash
+git clone https://github.com/yourusername/maya.git
+cd maya
+yarn install
 
-- `src/pages/`: This directory contains the main components of the application. Each file corresponds to a different page or feature of the app. Notable subdirectories include `Localities/`, `MainConsolidation/`, `Maps/`, `SVGHeatmapOverlay/`, `StartingZoom/`, and `Tutorial/`.
+```
+
+## Usage
+Start the development server by running:
+```bash
+yarn develop
+```
+
+Navigate to http://localhost:8000 to view the app in development mode.
+
+## Usage
+Contributions are welcome! Please follow these steps to contribute:
+
+Fork the repository.
+Create a feature branch (git checkout -b feature/YourFeature).
+Commit your changes (git commit -m 'Add some YourFeature').
+Push to the branch (git push origin feature/YourFeature).
+Open a pull request.
+
+## Usage
+
+Maya is poised for expansion to aid specialists and stakeholders throughout the Levant in transforming critical data into meaningful actions. Our vision extends to publishing the platform for broader use and securing funding for sustained impact.
+
+## Contact
+
+For more information on how to get involved or inquiries about the project, please contact:
+
+[Project Link - GitHub] (https://github.com/JackCrawfordRobertson/Maya.git)
+[Email Me] ([email protected])
+
+## License
+
+This project is licensed under the MIT License - see the LICENSE file for details.
 
-- `src/pages/Localities/InteractivePoints.js`: This file contains the interactive points for the localities.
 
-- `src/pages/MainConsolidation/App.js`: This is the main application file.
 
-- `src/pages/Maps/`: This directory contains files related to the map features of the application, including `BaseMap.js`, `Lebanon_Bekaa.css`, and `TownBorderMap.js`.
 
-The project uses npm and Yarn as package managers. To start the development server, run `yarn develop`.
 
-Please refer to the individual files and directories for more detailed information.