Prep for 0.5 release

sveinbjornt · Nov 5, 2023 · 2a2134a · 2a2134a
1 parent 3166e22
commit 2a2134a
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 5 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,9 @@
 # hear version history
 
+## v0.5 - 05/11/2023
+
+* Now supports setting a timeout for speech recognition via the -t flag
+
 ## v0.4 - 21/04/2023
 
 * Now supports -p flag to enable adding punctuation to speech recognition results (macOS 13+ only)

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ This makes it possible to transcribe spoken audio input or entire audio files.
 Apple's macOS has long shipped with the `say` tool, a command line interface
 for the operating system's venerable speech synthesis capabilities. As of
 10.15 "Catalina", it also ships with highly capable speech recognition for a variety
-of languages. This project is an attempt to provide a robust CLI for this functionality
+of languages. This project is an attempt to provide a robust native CLI for this functionality
 since no such tool is provided by Apple. `hear` supports speech recognition and
 transcription of both live microphone input and audio files in a variety of formats. 
 All formats supported by CoreAudio should work (e.g. WAV, MP3, AIFF, AAC, CAF, ALAC, etc.).
@@ -30,7 +30,7 @@ See the [man page](https://sveinbjorn.org/files/manpages/hear.1.html) for furthe
 [available](https://github.com/sveinbjornt/hear) under a [BSD license](#bsd-license). 
 **If you find this program useful, please [make a donation](https://sveinbjorn.org/donations).**
 
-* **[⇩ Download hear 0.4](https://sveinbjorn.org/files/software/hear.zip)** 
+* **[⇩ Download hear 0.5](https://sveinbjorn.org/files/software/hear.zip)** 
 (Intel/ARM 64-bit, macOS 10.15 or later, ~50 KB)
 
 ## Installation
@@ -48,16 +48,19 @@ This will install the binary into `/usr/local/bin` and the man page into
 ## Usage
 
 ### Transcribe audio from microphone (or default audio input device)
+
 ```
 hear
 ```
 
 ### From microphone in single line output mode
+
 ```
 hear -m
 ```
 
 ### Transcribe audio file
+
 ```
 hear -d -i /path/to/someone_speaking.mp3 > transcribed_text.txt
 ```

diff --git a/TODO.md b/TODO.md
@@ -1,4 +1,4 @@
 TODO for `hear` command line tool:
 
+* Get the tool into Homebrew
 * Add SRT creation from https://github.com/michaelnoguera/hear fork
-* Timeout option
diff --git a/hear.1.html b/hear.1.html
@@ -45,8 +45,8 @@
               Add punctuation to speech recognition results.
 
      <b>-x</b> <b>--exit</b> <u>exit</u><b>_<u></b>word</u>
-              Set exit word. This causes hear to exit when a speech
-              recognition result ends with the word in question.
+              Set exit word. This causes the program to exit when a speech
+              recognition result ends with the specified word.
 
      <b>-t</b> <b>--timeout</b> <u>seconds</u>
               Exit if no recognition results are received within the specified