From dc7a4e3abe60f7da917f852ce5881e8d70bb2dc6 Mon Sep 17 00:00:00 2001
From: kirahsapong <102400653+kirahsapong@users.noreply.github.com>
Date: Mon, 29 May 2023 08:19:40 -0700
Subject: [PATCH] Update codeowners, contributing, and readme docs (#41)

---
 CODEOWNERS      | 15 ++-----------
 CONTRIBUTING.md |  6 -----
 README.md       | 58 +++++++++++++++++++++++++++++++++++++------------
 3 files changed, 46 insertions(+), 33 deletions(-)

diff --git a/CODEOWNERS b/CODEOWNERS
index 2af39d0..527154e 100644
--- a/CODEOWNERS
+++ b/CODEOWNERS
@@ -1,9 +1,6 @@
 # This CODEOWNERS file denotes the project leads
 # and encodes their responsibilities for code review.
 
-# Instructions: At a minimum, replace the '@GITHUB_USER_NAME_GOES_HERE'
-# here with at least one project lead.
-
 # Lines starting with '#' are comments.
 # Each line is a file pattern followed by one or more owners.
 # The format is described: https://github.blog/2017-07-06-introducing-code-owners/
@@ -11,14 +8,6 @@
 # These owners will be the default owners for everything in the repo.
 *       @kirahsapong
 
-
-# -----------------------------------------------
-# BELOW THIS LINE ARE TEMPLATES, UNUSED
-# -----------------------------------------------
-# Order is important. The last matching pattern has the most precedence.
-# So if a pull request only touches javascript files, only these owners
+# If a pull request only touches .tsx files, only these owners
 # will be requested to review.
-# *.js    @octocat @github/js
-
-# You can also use email addresses if you prefer.
-# docs/*  docs@example.com
\ No newline at end of file
+*.tsx    @kirahsapong
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 212d9bb..71adc30 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,12 +24,6 @@ Design discussions and proposals take place on our [discord](https://discord.gg/
 
 We advocate an asynchronous, written debate model - so write up your thoughts and invite the community to join in!
 
-### Continuous Integration
-
-Build and Test cycles are run on every commit to every branch on [CircleCI](LINK_HERE).
-
- ___***FIX LINK ABOVE AND REMOVE THIS NOTICE***___
-
 ## Contribution
 
 We review contributions to the codebase via GitHub's Pull Request mechanism. We have 
diff --git a/README.md b/README.md
index da6afe9..da7fa5a 100644
--- a/README.md
+++ b/README.md
@@ -1,28 +1,58 @@
 # SSI Console
 
+## Introduction
+
 The SSI Console aims to provide a seamless experience for issuers and verifiers in the SSI ecosystem. With the SSI Console, issuers and verifiers can create and manage their DIDs, credential issuance flows, and presentation exchanges all in one place. 
 
 The SSI Console leverages the SSI Service API to simplify credential issuance and verification, and make both easy to do via a web interface.  
 
-## Introduction
+## Prerequisites
+
+* Node v19.4.0 and npm 9.2.0 or higher [Installation](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
+* Docker v20.10.24 or higher [Installation](https://docs.docker.com/get-docker/)
+* Docker Compose v.2.17.2  or higher [Installation](https://docker-docs.uclv.cu/compose/install/)
+
+Verify that `node` and `npm` commands are available:
+
+```
+node -v
+v19.4.0
+
+npm -v
+9.2.0
+```
+
+Verify that both `docker` and `docker-compose` commands are available:
+
+```
+docker --version
+Docker version 20.10.24, build 297e128
+
+docker-compose --version
+Docker Compose version v2.17.2
+```
+
+If you get a Permission Error, it means that your system currently requires docker to be executed as root, and the npm scripts won't work out-of-the-box unless you prefix docker commands with sudo or make it possible to run docker as a non-root user.
+
+## Scripts
+
+### `npm start`
+Start the SSI Console in developer mode and SSI Service Docker container. 
 
-Orient users to the project here. This is a good place to start with an assumption
-that the user knows very little - so start with the Big Picture and show how this
-project fits into it. It may be good to reference/link the broader architecture in the
-`collaboration` repo or the developer site here.
+### `npm run dev`
+Start the SSI Console in developer mode without also starting the SSI Service. Useful if the SSI Service is already running.
 
-Then maybe a dive into what this project does.
+### `npm run build`
+Create a production build of the SSI Console.
 
-Diagrams and other visuals are helpful here. Perhaps code snippets showing usage.
+### `npm run serve`
+After running `npm run build`, preview the production build of the SSI Console.
 
-Project leads should complete, alongside this `README`:
-* [CODEOWNERS](./CODEOWNERS) - set project lead(s)
-* [CONTRIBUTING.md](./CONTRIBUTING.md) - Fill out how to: install prereqs, build, test, run, access CI, chat, discuss, file issues
+### `npm run cleanup`
+Stop the SSI Service Docker container.
 
-The other files in this template repo may be used as-is:
-* [CODE_OF_CONDUCT.md](./CODE_OF_CONDUCT.md)
-* [GOVERNANCE.md](./GOVERNANCE.md)
-* [LICENSE](./LICENSE)
+### `docker pull ghcr.io/tbd54566975/ssi-service:main`
+Pull the latest SSI Service Docker container image.
 
 ## Project Resources