From 1c8d08cdc57d8faa756dc2d7879f4b937d83704a Mon Sep 17 00:00:00 2001
From: Angelo Cordon <angelocordon@gmail.com>
Date: Mon, 2 Sep 2019 22:20:03 -0700
Subject: [PATCH] Update README doc

---
 .env.example |  4 ++++
 README.md    | 39 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 43 insertions(+)

diff --git a/.env.example b/.env.example
index e69de29..ddc8848 100644
--- a/.env.example
+++ b/.env.example
@@ -0,0 +1,4 @@
+DATABASE=nodeconcept_dev
+DATABASE_USER=postgres
+DATABASE_PASSWORD=
+PORT=3000
diff --git a/README.md b/README.md
index d1ae012..a405793 100644
--- a/README.md
+++ b/README.md
@@ -5,11 +5,50 @@ Background: https://github.com/codebuddies/codebuddies/issues/1136
 Crowdsourced brainstorm of problems we want to solve: https://pad.riseup.net/p/BecKdThFsevRmmG_tqFa-keep
 
 # Proof-of-concept Goals
+
+- Resource CRUD
+
+TODO:
+
 - User profiles
   - How easy is it to set up an editable user profile?
 - Calendar/hangouts
   - How easy would it be to make a calendar widget that lets users block out times they're free for hangouts?
 
+# Getting Started
+
+Clone the project, run `npm install` and `npm start` to load up the server.
+If having database errors with postgres, see this guide on getting it set up:
+https://www.robinwieruch.de/postgres-sql-macos-setup
+https://www.robinwieruch.de/postgres-sql-windows-setup
+
+Copy `.env.example` as `.env` in the root directory. Not necessary to change the values at this time. Leave `DATABASE_PASSWORD` blank.
+
+# How to use
+
+Once the server is up, the application is available by visiting localhost:3000 in the browser. Using RESTful paths, going to `/resources` will list all current resources, `/resources/:resourceId` will show a single resource based on ID.
+
+Alternatively, you can use cURL to interface with application.
+
+```bash
+# returns an collection of Resource objects
+curl localhost:3000/resources
+```
+
+```bash
+# POST request to create a new Resource with a JSON payload
+curl -d '{ "title": "Some title!", "description": "Great description!" }' -H 'Content-Type: application/json' localhost:3000/resources
+```
+
+```bash
+# DELETE request to delete a resource with the resource ID of 3
+curl -X DELETE localhost:3000/resources/3
+```
+
 # Findings
 
+TBD
+
 # Technologies Used
+
+Node, Express, Postgres, Sequelize (ORM to handle models and Postgres).