From a83507bcf96e452ae6e7a673392137346c7d4eea Mon Sep 17 00:00:00 2001
From: Alexander Huddleston <adh9694@gmail.com>
Date: Sat, 7 Mar 2020 20:05:14 -0600
Subject: [PATCH] Updated README, minor changes to Pipfile.

---
 Pipfile   |  3 ---
 README.md | 49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 2 files changed, 48 insertions(+), 4 deletions(-)

diff --git a/Pipfile b/Pipfile
index 6e53640..02d989c 100644
--- a/Pipfile
+++ b/Pipfile
@@ -15,6 +15,3 @@ flask-login = "*"
 psycopg2-binary = "*"
 sqlalchemy = "*"
 flask-sqlalchemy = "*"
-
-[required]
-python = "3.8.0"
diff --git a/README.md b/README.md
index c3cfdc4..d8e8348 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,50 @@
 # UWU Me!
 
-A small project meant to have a different take on Please-Pet.
+**NOTE: This project is very much still in the development/prototype stages. It is in no way meant to be run at a production level, as many security features have not been implemented yet. Run this with caution, and encourage any potential users not to create accounts with sensitive passwords.**
+
+A small project meant to be a different take on [PleasePet](https://github.com/sammy123k/pleasepet).
+
+Tired of simply "liking" or "favoriting" those _so called_ ___"POSTS"___ ?
+
+Why not give people an "UwU"??
+
+This web app allows users to sign up and create a page of their own for other users and anonymous users to give an "UwU" reaction to.
+
+This is intended to stay a fairly simple app acting as a feasible project for the author to learn about developing web apps with login and user management, an asynchronous data store, and interaction with a database storage container.
+
+## Requirements
+
+Here is an outline of the requirements necessary to run this service:
+
+- Python 3.6+
+  - Pipenv
+
+Pipenv will act as the Python package manager for the installation of Python you use, creating a virtual environment that satisfies the package requirements listed in the `Pipfile`.
+
+If you do not wish to use pipenv, you will need the following packages:
+
+- flask
+- flask-login
+- psycopg2-binary
+
+## Usage
+
+### Native
+
+To start the app, simply run `start_app.sh`.
+
+```
+./start_app.sh
+```
+
+### Docker Compose
+
+Optionally, you can run the entire application using the included `docker-compose` file.
+
+```
+# These commands may require sudo
+docker-compose up --build
+
+# If you wish to detach the container after running
+docker-compose up --build -d
+```