From 3a48ae774984d641f5cc12e8a69480f623263e86 Mon Sep 17 00:00:00 2001
From: Barry Hess <barry@bjhess.com>
Date: Sat, 26 Oct 2024 16:18:42 -0500
Subject: [PATCH] Readme updates from a first time installer (#213)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* README updates.

I had some challenges getting things up and running, so here are some
README updates. Curated over a lovely session on Discord.

* .gitignore RubyMine files.

If that's okay to land in the repo? ❤️
---
 .gitignore |  3 +++
 README.md  | 23 +++++++++++++++++++----
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/.gitignore b/.gitignore
index 2770b16e..a4078958 100644
--- a/.gitignore
+++ b/.gitignore
@@ -161,6 +161,9 @@ docs/.bridgetown-cache
 
 .DS_Store
 
+# Ignore RubyMine files.
+.idea/
+
 /exports
 /internal
 /cdn
diff --git a/README.md b/README.md
index e9dc9d22..06a53feb 100644
--- a/README.md
+++ b/README.md
@@ -19,15 +19,20 @@ We have a test suite using Ruby on Rails and is intended to
 provide a good demonstration of how this package can hook
 into ActionText.
 
+Contributions should be made on a feature branch in a 
+forked repository.
+
 ### Prerequisites
 
 - Ruby 3.1.2
 - Rails 7.0.4
 - PNPM (`npm install -g pnpm`)
-- Playwright
+- Playwright (`npm install -g playwright`)
 - Node >= 16
 - Docker (Used to run a simulated S3 server)
-- Overmind (Preferred, not needed)
+- A Docker virtualizer ([Orbstack](https://orbstack.dev/) or
+  [Docker Desktop](https://www.docker.com/products/docker-desktop/))
+- Overmind (Preferred, not needed `npm install -g overmind`)
 
 ### Installation
 
@@ -42,9 +47,19 @@ pnpm run setup
 
 ### Running the server
 
-The easiest way to run the server is using [Overmind](https://github.com/DarthSim/overmind)
+The easiest way to run the server is using [Overmind](https://github.com/DarthSim/overmind).
+First start up your Docker virtualizer, then in two termainals…
+
+Terminal 1:
+
+```bash
+pnpm run start
+```
+
+Terminal 2:
 
 ```bash
+cd tests/rails
 overmind start -f Procfile.dev
 ```
 
@@ -53,7 +68,7 @@ Then navigate to `localhost:5100`
 
 #### Without Overmind
 
-To run the server without overmind do the following in
+To run the server without Overmind do the following in
 seperate terminals:
 
 ```bash