Update Say extension

pilotmoon · Aug 29, 2023 · b818c10 · b818c10
1 parent d2822fc
commit b818c10
Show file tree

Hide file tree

Showing 6 changed files with 34 additions and 37 deletions.
diff --git a/extensions/Say.popclipextz b/extensions/Say.popclipextz
diff --git a/source/Say.popclipext/Config.json b/source/Say.popclipext/Config.json
@@ -0,0 +1,10 @@
+{
+  "identifier": "com.pilotmoon.popclip.extension.say",
+  "name": "Say",
+  "icon": "speechicon.png",
+  "popclipVersion": 4069,
+  "shellScriptFile": "say.zsh",
+  "interpreter": "zsh",
+  "stdin": "text",
+  "description": "Speak the selected text aloud, using the system default voice."
+}
diff --git a/source/Say.popclipext/Config.plist b/source/Say.popclipext/Config.plist
diff --git a/source/Say.popclipext/README.md b/source/Say.popclipext/README.md
@@ -1,4 +1,23 @@
-Say
-===
+# Say
 
-PopClip extension to speak the text aloud.
+PopClip extension to speak the text aloud using the Mac's built-in text-to-speech.
+
+The extension simply invokes the `say` command-line tool, which is included with macOS.
+
+The text is spoken using the default voice settings, which can be changed in System Settings → Accessibility → Spoken Content.
+
+## Changelog
+
+### 2023-08-29
+
+- Update to "modern" extension structure with JSON config, for documentation example purposes.
+- Use `stdin` instead of shell variable for input.
+- Update Readme to describe the new location of the default voice settings.
+
+### 2017-07-17
+
+- Fix bug when input contained `*` character.
+
+### 2012-01-08
+
+- Initial release.
diff --git a/source/Say.popclipext/say.sh b/source/Say.popclipext/say.sh
diff --git a/source/Say.popclipext/say.zsh b/source/Say.popclipext/say.zsh
@@ -0,0 +1,2 @@
+# the text will be read from stdin
+say