From 1fa11482ff442bed7371dda554d6b0e0a196af9b Mon Sep 17 00:00:00 2001
From: Alisha Mohanty <alishamohanty1416@gmail.com>
Date: Feb 24 2019 12:28:47 +0000
Subject: Improvement in Documentation


---

diff --git a/README.md b/README.md
index 10a18f0..e4d4e1a 100644
--- a/README.md
+++ b/README.md
@@ -1,32 +1,62 @@
-# fedora-happiness-packets
+# Fedora-Happiness-Packets
 
-This project contains the codebase for fedora hosted version of happinesspackets.io to be used during Appreciation week. The live service is hosted [here](http://happinesspackets.fedorainfracloud.org)
+Fedora-Happiness-Packets contains the codebase for fedora hosted version of [happinesspacks.io](https://happinesspackets.io) to be used during appreciation week. The live service is hosted [here](http://happinesspackets.fedorainfracloud.org).
 
-# Setup
+## Getting Started
 
-Make sure you have Docker and Docker Compose installed.
+These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
 
-In order for the login and send views to work, you must supply an OpenID Connect Client ID and Client Secret:
+### Prerequisites
 
-    chmod +x generate_client_secrets.sh 
-    ./generate_client_secrets.sh 
+You require the following things for the software to be installed.
 
-To run on http://localhost:8000/ :
+- Docker
+- Docker-Compose
+- Python (Version 3 is recommended)
 
-    docker-compose up
+## Installing
 
-After making any changes to the code, make sure to rebuild the container:
+Clone the repository:
+
+```
+git clone https://pagure.io/fedora-commops/fedora-happiness-packets.git
+```
 
-    docker-compose up --build
+Change the working directory to fedora-happiness-packets
 
+```
+cd fedora-happiness-packets
+```
 
-The ``t`` command is a very short shell script that runs the tests with the correct settings and reports on coverage.
+In order for the login and send views to work, you must supply an OpenID Connect Client ID and Client Secret:
+
+```
+chmod +x generate_client_secrets.sh
+./generate_client_secrets.sh
+```
 
-To run it:
-    
-    docker-compose exec web sh
-    ./t
+## Running
 
+To run on http://localhost:8000/ :
+```
+docker-compose up
+```
+After making any changes to the code, make sure to rebuild the container:
+```
+docker-compose up --build
+```
+## Testing
+
+The `t` command is a very short shell script that runs the tests with the correct settings and reports on coverage.
+While the docker is up, in another shell run :
+```
+docker-compose exec web sh
+./t
+```
 To run the integration tests::
+```
+./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting
+```
+### License
 
-    ./manage.py test -v 2 -p integration_test*.py --settings=happinesspackets.settings.tsting
+This project is licensed under the Apache License - see LICENSE in files.