From 77f3ec4303ac62fb4285d344d9b4f92555f7241d Mon Sep 17 00:00:00 2001
From: Egor Zadorin <egorzadorin04@gmail.com>
Date: Fri, 6 Oct 2023 15:32:17 +0200
Subject: [PATCH] Update README.md

---
 README.md | 28 +++++++++++++++++++++++++++-
 1 file changed, 27 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 03a05ce7..61efaf98 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,27 @@
-Sample
+# Vue Website and Spring Lambda Backend for Email Service
+
+This repository contains two main components:
+1. `main-website` - A [Personal Website](https://egorzadorin.com) built using VueJS, HTML and CSS.
+2. `spring-lambda` - A frontend component for an [Email Service](https://github.com/EgorZadorin/poc-aws-lambda-spring-boot), built using same technical stack.
+
+Both applications are included in a single repository for the convenience of using GitHub Actions to automatically deploy them to an AWS EC2 instance on each git push.
+
+## Prerequisites
+
+- Node.js and npm for both `main-website` and `spring-lambda`
+
+## Build and Run 
+
+Navigate to the `main-website` or `spring-lambda` directory and execute the following commands:
+```
+npm install
+npm run serve
+```
+
+## Contribution
+
+If you find any issues or have suggestions for improvements, feel free to open an issue or make a pull request.
+
+## License
+
+MIT