From 54759ff78f63bf62fc7c126dff64925d5c1fc105 Mon Sep 17 00:00:00 2001
From: Gabriel Kosmacher <73120774+kennykos@users.noreply.github.com>
Date: Thu, 9 Mar 2023 18:41:59 -0600
Subject: Updating README with binder button and info

---
 README.md | 27 ++++++++++++++++++---------
 1 file changed, 18 insertions(+), 9 deletions(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e135132..8e19ed5 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,28 @@
 # toriis-analysis
-Repository for scripts to evaluate public institutional investment data.
+Repository for scripts to evaluate public institutional investment data. These scripts are designed to be launched with [binder](https://mybinder.org/) so that other community members can run their own analyses without any additional setup.
+
+
+
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/toriis-portal/toriis-analysis/HEAD)
 
 # Running existing notebook
 
-1) 
-	+ Fork + clone repo
-	+ Run `setup/setup.sh` to set up the local conda environment
+1. **Interactive, UI-only:** Launch the repo in binder and clone one of the example notebooks
+1. **Interactive, CLI only:** 
+	1. Fork + clone repo
+	1. Run `setup/setup.sh` to set up the local conda environment
 		- you may need to install the correct version of miniconda
-	+ Start a local notebook suerver (`juypter notebook`)
+	1. Start a local notebook suerver (`juypter notebook`)
 
 # Contributing
 
 You are welcome to contribute data and analysis results. Please make sure that you contribute **cleared notebooks** so version control capabilities work well. To clear a notebook, use `Kernel -> Researt & Clear Output)` 
 
-1) **CLI:**
-	+ Create a new branch (`$ git checkout -b <branch_name>`)
-	+ Commit the new notebook/data (`$ git add <new file>; git commit`)
-	+ Push and generate a pull request
+1. **UI-only:**
+    1. Download the notebook (Download -> ipynb)
+    1. Upload the notebook using the GitHub UI (Upload Files, next to Clone or Download)
+1. **CLI only:** Follow the [instructions on github](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) - i.e.
+    1. Create a new branch (e.g. `$ git checkout -b`)
+    1. Commit the new notebook (e.g. `$ git add` and `$ git commit`)
+    1. Push and generate pull request 
+
-- 
cgit v1.2.3


From 2d7b47b8f44b52d21e8df9ca1bce2c5cbd998944 Mon Sep 17 00:00:00 2001
From: Gabriel Kosmacher <73120774+kennykos@users.noreply.github.com>
Date: Fri, 10 Mar 2023 12:29:22 -0600
Subject: Update README.md

Added status badge
---
 README.md | 1 +
 1 file changed, 1 insertion(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 8e19ed5..c708323 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,4 @@
+[![analysis-notebook-test-binder](https://github.com/kennykos/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml/badge.svg)](https://github.com/kennykos/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml)
 # toriis-analysis
 Repository for scripts to evaluate public institutional investment data. These scripts are designed to be launched with [binder](https://mybinder.org/) so that other community members can run their own analyses without any additional setup.
 
-- 
cgit v1.2.3


From d92093d87deee8b0a03a13af4a53f78753e9ab77 Mon Sep 17 00:00:00 2001
From: Gabriel Kosmacher <73120774+kennykos@users.noreply.github.com>
Date: Fri, 10 Mar 2023 13:45:53 -0600
Subject: Update README.md

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index c708323..56e51d9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-[![analysis-notebook-test-binder](https://github.com/kennykos/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml/badge.svg)](https://github.com/kennykos/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml)
+[![analysis-notebook-test-binder](https://github.com/toriis-portal/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml/badge.svg)](https://github.com/toriis-portal/toriis-analysis/actions/workflows/analysis-notebook-test-binder.yml)
 # toriis-analysis
 Repository for scripts to evaluate public institutional investment data. These scripts are designed to be launched with [binder](https://mybinder.org/) so that other community members can run their own analyses without any additional setup.
 
-- 
cgit v1.2.3