updates README (#72)

apoclyps · May 3, 2021 · 7b6daf3 · 7b6daf3
1 parent 9593f46
commit 7b6daf3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 11 deletions.
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,7 +8,7 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. 
+A clear and concise description of what the problem is.
 
 **Describe the solution you'd like**
 A clear and concise description of what you want to happen.

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -70,4 +70,4 @@ members of the project's leadership.
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
-[homepage]: https://www.contributor-covenant.org
+[homepage]: https://www.contributor-covenant.org
diff --git a/README.md b/README.md
@@ -1,20 +1,17 @@
-# Code Review Manager
+# Reviews
 
-> Simplify code review with an all in one dashboard providing an overview of open PRs !
+> Simplify code review with an all-in-one TUI dashboard providing an overview of open PRs requiring review!
 
 ### Quick Start
 
 If you want to get up and running with Code Review Manager immediately, run:
 
 ```bash
-# your github username
 export GITHUB_USER="your-github-username"
-# your personal github token used for interacting with the API
-export GITHUB_TOKEN="your-github-token"
-# comma seperated list of org/repo
+export GITHUB_TOKEN="your personal github token used for interacting with the API"
 export REPOSITORY_CONFIGURATION="apoclyps/code-review-manager"
 
-pip install reviews
+pip install --upgrade reviews
 
 reviews dashboard
 ```
@@ -43,19 +40,21 @@ $ pip install -e .
 $ reviews dashboard
 ```
 
-Alternatively, you can also run the code review manager within Docker:
+You can run the code review manager within Docker:
 
 ```bash
 docker-compose build cli && docker-compose run --rm cli python cli.py dashboard
 ```
 
-Alternatively, you can use docker to build an image and run that image with all of the necessary dependencies using the following commands:
+To build an image and run that image with all of the necessary dependencies using the following commands:
 
 ```bash
 $ docker-compose build cli
 $ docker-compose run --rm cli python cli.py dashboard
 ```
 
+For instructions on setting up a development enviroment outside of Docker, checkout the [wiki](https://github.com/apoclyps/reviews/wiki/Development-Enviromnent).
+
 ### Testing
 
 A test suite has been included to ensure Code Review Manager functions correctly:.