README.adoc in pennyworth-11.2.0 vs README.adoc in pennyworth-11.2.1
- old
+ new
@@ -14,11 +14,11 @@
image::https://circleci.com/gh/bkuhlmann/pennyworth.svg?style=svg[Circle CI Status]
Pennyworth is a command line interface and the perfect companion to
link:https://www.alfredapp.com[Alfred]. With Pennyworth, you can unlock the full potential of the
Ruby language by leveraging modern versions of Ruby through Alfred Workflows. Perfect for when you
-want to advance beyond the based workflows Alfred provides by default.
+want to advance beyond the basic workflows Alfred provides by default.
toc::[]
== Features
@@ -34,13 +34,22 @@
. link:https://www.apple.com/macos[macOS]
. link:https://www.gnu.org/software/bash[Bash]
. link:https://www.alfredapp.com[Alfred]
. link:https://www.alfredapp.com/purchase[Alfred Powerpack]
-. {frum_link}
. link:https://www.ruby-lang.org[Ruby]
+While using a Ruby version manager -- like {frum_link} -- is not a hard requirement, it is strongly
+encouraged since a version manager will give you the freedom to toggle between different Ruby
+versions since this gem has strict Ruby version requirements (especially in regards to using a
+modern version of Ruby).
+
+I would also like to point out that all of the workflows, scripts, examples for this gem use Bash
+syntax. That said, if you are comfortable with translating Bash syntax to your shell syntax of
+choice, you can make this gem work in different shells too. That is beyond the scope of this
+document, though, so leave that exercise up to you.
+
== Setup
To install, run:
[source,bash]
@@ -205,10 +214,12 @@
link:https://www.gnu.org/software/bash[Bash] and load your environment appropriately. Bash is not
a hard requirement, though. You can use _any shell_ you are comfortable with as long as you teach
Alfred to load your development environment before running the Alfred Workflow.
2. You have the latest version of Alfred, Ruby, and Pennyworth installed.
3. You are using a Ruby version manager, like {frum_link}, which ensures Ruby is on your load path.
+ As mentioned in the _Requirements_ section above, this is not a hard requirement so if you have
+ the correct version of Ruby required by this gem on your path, that'll work too.
With the above requirements in mind, the following sections document how to download and install all
Pennyworth workflows that are compatible with Alfred. Should you want to tweak any of these
workflows, you'd only need to edit an existing workflow or build your own with these settings:
@@ -500,10 +511,10 @@
double click to install.
2. Open the workflow to see all available keywords.
===== Terraform
-image:https://www.alchemists.io/images/projects/pennyworth/screenshots/terraform.png[Terraform workflow screenshot.,width=362,height=524,role=focal_point]
+image:https://www.alchemists.io/images/projects/pennyworth/screenshots/terraform.png[Terraform workflow screenshot.,width=706,height=632,role=focal_point]
Provides link:https://www.terraform.io[Terraform] resources.
1. link:https://www.alchemists.io/public/aflred/workflows/terraform.alfredworkflow[Download] and
double click to install.