From 9aa01d46fcf30b1a598a5014ee594a495bafdb32 Mon Sep 17 00:00:00 2001
From: Johnathon Slightham <slighthamj@gmail.com>
Date: Tue, 4 May 2021 02:23:04 -0400
Subject: [PATCH] Create README.md

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3c780ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# kno-logic-api
+<p align="center">
+  <img src="https://imgur.com/P2nDq7b.png" width="180">
+</p>
+
+Kno-logic is a mobile learning platform with a short number of curated articles added daily for lifelong learners. This API was built with NodeJS and Express, and uses MongoDB as a database.
+
+## Developing locally
+If you would like to run the application you will need:
+ - NodeJS 14
+ - MongoDB Community
+
+Install the latest version of [`Node.js`](https://nodejs.org/en/). 
+Install the latest version of [`MongoDB Community Server`](https://www.mongodb.com/community). 
+Clone the repository, and run the following:
+```bash
+# start database
+mongod
+
+# install dependencies
+npm install
+
+# server with hot reload (optional, requires nodemon)
+nodemon
+
+# running the server
+node .
+```