diff --git a/README.md b/README.md index 82c9cbd..b23b9d6 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# Secret-Note-MVC-Rawan-Mostafa \ No newline at end of file +# Secret-Note Application + +This repository implements a Secret Note Sharing Application, it's a web application that allows users to securely share self-destructing secret notes. + +The notes are created with a random url that can't be easily guessed, has self destruction feature using maximum views or expiration time + +## Table of Contents + +- [features](#features) +- [Installation](#installation) +- [Usage](#usage) + +## Features +- Note Creation : + + - Users can create a note with text content + - Generate a unique, secure URL for each note + - Set an expiration time or number of views before destruction +- Note Retrieval : + + - Users can view a note using the unique URL + - After viewing or upon expiration, the note is permanently deleted +- Security Features: + + - We use secure random generation for URLs so that the urls aren't predictable + +## Installation + +Clone the repository + + ```bash + git clone https://github.com/codescalersinternships/Secret-Note-MVC-Rawan-Mostafa.git + ``` + +## Usage +Run the docker container using docker-compose +```bash + docker-compose up +``` +You'll then find the url of your app printed in the terminal, and here you go you can signup and start making notes securely! + +![alt text](image.png) \ No newline at end of file diff --git a/image.png b/image.png new file mode 100644 index 0000000..ab63241 Binary files /dev/null and b/image.png differ