README.adoc in pennyworth-11.1.0 vs README.adoc in pennyworth-11.1.1

- old
+ new

@@ -1,9 +1,11 @@ :toc: macro :toclevels: 5 :figure-caption!: +:frum_link: link:https://github.com/tako8ki/frum[Frum] + = Pennyworth [link=http://badge.fury.io/rb/pennyworth] image::https://badge.fury.io/rb/pennyworth.svg[Gem Version] [link=https://www.alchemists.io/projects/code_quality] @@ -21,19 +23,19 @@ * Supports building advanced link:https://www.alfredapp.com/help/workflows[Workflows] for personal augmentation. == Screencast -video::https://www.alchemists.io/videos/projects/pennyworth/demo.mp4[poster=https://www.alchemists.io/images/projects/pennyworth/demo.png,width=1062,height=1194,role=focal_point] +video::https://www.alchemists.io/videos/projects/pennyworth/demo.mp4[poster=https://www.alchemists.io/images/projects/pennyworth/demo.png,width=700,height=636,role=focal_point] == Requirements . 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] -. link:https://github.com/postmodern/chruby[chruby] +. {frum_link} . link:https://www.ruby-lang.org[Ruby] == Setup To install, run: @@ -176,12 +178,11 @@ 1. Your link:https://www.alchemists.io/projects/dotfiles[Dotfiles] are configured to use 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 link:https://github.com/postmodern/chruby[chruby], - which ensures Ruby is on your load path. +3. You are using a Ruby version manager, like {frum_link}, which ensures Ruby is on your load path. 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: @@ -283,10 +284,19 @@ link:https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#Unofficial_codes[unofficial codes]. Type `https` to activate. Use `ENTER` to copy symbol, `CONTROL` to copy code, `OPTION` to copy label, or `COMMAND` to view documentation. +===== Links + +image:https://www.alchemists.io/images/projects/pennyworth/screenshots/ruby-links.png[Links,width=706,height=632,role=focal_point] + +This keyword allows you to navigate to additional Ruby related information and resources. + +Type `rb` plus `SPACE` to activate, then fuzzy type to filter the list to what you are looking for, +and hit `ENTER` to visit the link in your default browser. + ===== Number image:https://www.alchemists.io/images/projects/pennyworth/screenshots/ruby-number.png[Number,width=706,height=200,role=focal_point] This keyword allows you to generate a random number. @@ -367,14 +377,16 @@ Launches development environment but can be tweaked for your preferences. Using Alfred in this manner ensures your machine boots or restarts quickly and gives you more control over what is launched. * link:https://www.alchemists.io/public/aflred/workflows/browsers.alfredworkflow[Browsers] - Provides browser related utilities. +* link:https://www.alchemists.io/public/aflred/workflows/bundler.alfredworkflow[Bundler] - Provides + quick access to link:https://bundler.io[Bundler] related resources. * link:https://www.alchemists.io/public/aflred/workflows/hanami.alfredworkflow[Hanami] - Provides link:https://hanamirb.org[Hanami] resources. * link:https://www.alchemists.io/public/aflred/workflows/chlli.alfredworkflow[chi.li] - Shortens - URLs. + URLs using link:https://chl.li[chl.li]. * link:https://www.alchemists.io/public/aflred/workflows/docker.alfredworkflow[Docker] - Provides link:https://www.docker.com[Docker] resources. * link:https://www.alchemists.io/public/aflred/workflows/mac_os.alfredworkflow[macOS] - Provides macOS utilities. * link:https://www.alchemists.io/public/aflred/workflows/terraform.alfredworkflow[Terraform] - @@ -385,17 +397,16 @@ == Architecture The following documents the workfow used to process all actions from Alfred. -image::/doc/architecture.svg[Architecture Diagram] +image::https://www.alchemists.io/images/projects/pennyworth/doc/architecture.svg[Architecture Diagram] == Troubleshooting * link:https://github.com/ruby/psych[Psych] 4.0.0 has a link:https://github.com/ruby/psych/issues/490[bug] which prevents loading of YAML configurations - that use symbols as keys. If you get caught by this, uninstall Psych 4.0.0 and fall back to 3.x.x - instead. + that use symbols as keys. If you get caught by this, please upgrade to Psych 4.0.1 for the fix. * When your Alfred Workflow yields no output, you might want to open the link:https://www.alfredapp.com/help/workflows/utilities/debug[Alfred Debugger], rerun your workflow, and check for errors. You can also jump to the CLI and run Pennyworth directly. * If you get GitHub authorization errors, make sure you have defined the appropriate credentials (mentioned earlier) for both within your shell where you are running Pennyworth or within the