README.adoc in pennyworth-17.4.1 vs README.adoc in pennyworth-17.5.0
- old
+ new
@@ -2,11 +2,13 @@
:toclevels: 5
:figure-caption!:
:alfred_link: link:https://www.alfredapp.com[Alfred]
:bash_link: link:https://www.gnu.org/software/bash[Bash]
+:htmx_link: link:https://htmx.org[htmx]
:ruby_link: link:https://www.ruby-lang.org[Ruby]
+:ruby_string_format_link: link:https://docs.ruby-lang.org/en/master/format_specifications_rdoc.html[String Format]
:ruby_version_managers_link: link:https://alchemists.io/articles/ruby_version_managers[Ruby Version Manager]
= Pennyworth
Pennyworth is a command line interface and the perfect companion to
@@ -179,21 +181,25 @@
api_url: "https://api.github.com"
http:
statuses:
url: "https://developer.mozilla.org/docs/Web/HTTP/Status"
htmx:
- examples_uri: "https://htmx.org/examples"
- references_uri: "https://htmx.org/reference"
+ examples_uri: "%<htmx_site_uri>s/examples"
+ extensions_uri: "%<htmx_site_uri>s/extensions"
+ references_uri: "%<htmx_site_uri>s/reference"
+ site_uri: "https://htmx.org"
ruby_gems:
api_url: "https://rubygems.org/api/v1"
standard_gems:
api_url: "https://stdgems.org"
----
Feel free to take this default configuration, modify, and save as your own custom
`configuration.yml`.
+For {htmx_link}, the Ruby {ruby_string_format_link} specification is used which means you can define the `site_uri` once and have it automatically resolved in all URIs that reference it. Otherwise, you can use literal URIs if desired.
+
=== Themes
image:https://alchemists.io/images/projects/pennyworth/screenshots/alchemists-theme.png[Alchemists Theme,width=706,height=632,role=focal_point]
The above is shared as the link:https://www.alfredapp.com/extras/theme/FSz9kjN1wX[Alchemists Alfred
@@ -256,11 +262,11 @@
===== htmx
image:https://alchemists.io/images/projects/pennyworth/screenshots/htmx.png[htmx workflow screenshot.,width=706,height=631,role=focal_point]
-Provides quick access to the link:https://htmx.org[htmx] JavaScript library.
+Provides quick access to the {htmx_link} JavaScript library.
1. link:https://alchemists.io/public/alfred/workflows/htmx.alfredworkflow[Download] and
double click to install.
2. Click on _Configure Workflow_ to view documentation.
@@ -646,10 +652,10 @@
=== Architecture
The following documents the workflow used to process all actions from Alfred.
-image::https://alchemists.io/images/projects/pennyworth/doc/architecture.svg[Architecture Diagram]
+image::https://alchemists.io/images/projects/pennyworth/doc/architecture.png[Architecture Diagram,width=1265,height=2377,role=focal_point]
== Tests
To test, run: