Merge pull request #196 from mr-mustash/u/patrickking/readme_updates_…

…20231214

README Updates

README.md

@@ -1,20 +1,18 @@
-<p align="center">
+<div align="center">
     <img src="https://i.imgur.com/WidJ8uW.jpg">
-
-    <br>
+    <p>
     <a href="https://results.pre-commit.ci/latest/github/mr-mustash/dotfiles/main"><img src="https://results.pre-commit.ci/badge/github/mr-mustash/dotfiles/main.svg" alt="pre-commit.ci status"></a>
-    <a href="https://github.com/mr-mustash/dotfiles/actions/workflows/snyk-container-analysis.yml"><img src="https://img.shields.io/github/workflow/status/mr-mustash/dotfiles/Snyk%20Container?label=Snyk%20Container%20Check&logo=Snyk" alt="Snyk container analysis"></a>
-    <a href="https://github.com/mr-mustash/dotfiles/actions/workflows/docker-image.yml"><img src="https://img.shields.io/github/workflow/status/mr-mustash/dotfiles/Docker%20Image%20Build?label=Docker%20Image%20Build&logo=Docker" alt="docker image build"></a>
-    <a href="https://hub.docker.com/repository/docker/mrmustash/homedir"><img src="https://img.shields.io/docker/cloud/build/mrmustash/homedir?label=mrmustash%2Fhomedir%3Alatest&logo=docker" alt="docker cloud build"></a>
-
-    <br>
-    <a href="https://unlicense.org/"><img src="https://img.shields.io/github/license/mr-mustash/dotfiles?color=blue&label=Licence&logo=Unlicense" alt="license"></a>
+    <a href="https://github.com/mr-mustash/dotfiles/actions/workflows/snyk-container-analysis.yml"><img src="https://img.shields.io/github/actions/workflow/status/mr-mustash/dotfiles/snyk-container-analysis.yml?label=Snyk%20Container%20Check&logo=Snyk" alt="Snyk container analysis"></a>
+    <a href="https://github.com/mr-mustash/dotfiles/actions/workflows/docker-image.yml"><img src="https://img.shields.io/github/actions/workflow/status/mr-mustash/dotfiles/docker-image.yml?label=Docker%20Image%20Build&logo=Docker" alt="docker image build"></a>
+    </p>
+    <p><a href="https://unlicense.org/"><img src="https://img.shields.io/github/license/mr-mustash/dotfiles?color=blue&label=Licence&logo=Unlicense" alt="license"></a></p>
+</div>
 
-<p>
+# Dotfiles
 
 Welcome to mr_mustash's dotfiles repo. These configurations have evolved from originally [committing](https://github.com/mr-mustash/dotfiles/tree/9c2b4e315b7a37742b1d2c3b601c3b184c3e9459) my `.config/fish` and `.vimrc` directories to now being a fully automated deployment for when I set up a new machine.
 
-My configuration has, at this point, been _very_ tailored to the way that I work and I _do not_ recommend that you just check this repo out and use it wholesale for yourself. However, if you find any parts of my configuration you are welcome to use them as your own! I have decided to use the [Unlicense](https://unlicense.org/) for this repo so that there are no constraints as to how anyone can use code that they find here. I do hope that people will find parts of this repo useful, just as I have found many other dotfiles repos useful on my journey.
+My configuration has, at this point, been incredibly tailored to the way that I work and I _do not_ recommend that you `git clone` this repo and use it wholesale for yourself. If you find any parts of my configuration helpful you are welcome to use them as your own! I have decided to use the [Unlicense](https://unlicense.org/) for this repo so that there are no constraints on how anyone can use code that they find here. I hope that people will find parts of this repo useful, much as I have found other dotfiles repos useful on my journey.
 
 ## Configuration Specific READMEs
 
@@ -24,10 +22,10 @@ My configuration has, at this point, been _very_ tailored to the way that I work
 
 ## Docker
 
-I very much _DO NOT_ recommend that people just use these dotfiles wholesale for themselves. However, if you'd like to try them out I have published a container [available on Dockerhub](https://hub.docker.com/repository/docker/mrmustash/homedir/) for a convenient way to test out what my environment is like.
+As sated before I don't think it's wise for people to use this wholesale, however if you would like to try them out as-is I have published a container [available on Dockerhub](https://hub.docker.com/repository/docker/mrmustash/homedir/) for a convenient way to test out what my environment is like.
 
 The best experience can by had by running `docker run -it -e TERM=xterm-256color --net host mrmustash/homedir:latest`.
 
 ## Terminal Settings
 
-I have always used DejaVu Sans Mono, but have recently switched to using [Nerd Fonts](https://www.nerdfonts.com/#home) DejaVu Sans Mono.
+I have always used DejaVu Sans Mono, but have switched to using [Nerd Fonts](https://www.nerdfonts.com/#home) DejaVu Sans Mono for easy access to custom glyphs. Both my Fish and Vim config rely on these patched fonts, and the terminal will look quite strange without them.

tilde/.config/fish/README.md

@@ -24,14 +24,6 @@ In a directory with golang and Docker files after a command took 52 seconds to r
 After running a k8s command inside a directory with golang that has uncommitted git changes and one job running in the background.
 ![](https://i.imgur.com/VDGRoWi.png)
 
-### Async Features
-
-The aspect of my prompt that I'm most proud of is making the longest running bits asynchronous. After originally creating this prompt I noticed that my `__fish_prompt_git_status` command would take a long time to return in directories with lots of submodules, see: this repo, and I knew that it wouldn't do. Since I was new to Fish I tried a lot of ideas that other people had offered, and none of them seemed to work until I found [@MaxMilton](https://github.com/MaxMilton) "Pure" Fish theme and it's async features. As of now my prompt will draw almost always in under 50ms and will load in elements as the finish processing.
-
-### Auto `git fetch`
-
-Using the async features above I automatically `git fetch` if it's been more than 10 minutes since it's happened on any given repo. This works great with the `git status` party of my prompt as it'll display a `↓` symbol when I'm behind from origin.
-
 ## Functions
 
 ## Completions
@@ -49,5 +41,4 @@ Since Fish does not have a built in history search function I've decided to use
 ## Greets
 
 - [@zgracem](https://github.com/zgracem) for the [modular prompt idea](https://github.com/zgracem/dotconfig/tree/master/fish). It changed the entire way of how I think about building a prompt.
-- [@MaxMilton](https://github.com/MaxMilton) for creating an [async prompt](https://github.com/MaxMilton/pure/blob/master/functions/__pure_run_async.fish) that works with my setup. I tried different async methods for Fish prompt before finding one that works for me.
 - [@matchi](https://github.com/matchai) for creating [spacefish](https://github.com/matchai/spacefish) that inspired the look of my prompt, and it's ideas around modularity.

tilde/.config/nvim/README.md

@@ -3,3 +3,5 @@
 <p align="center">
     <img src="https://i.imgur.com/p2s9QwN.png">
 </p>
+
+# TODO

tilde/.hammerspoon/README.md

@@ -0,0 +1,7 @@
+# Hammerspoon
+
+<p align="center">
+<img src="https://i.imgur.com/5EcnvWb.png">
+</p>
+
+# TODO

tilde/.hammerspoon/secrets.lua.example

@@ -0,0 +1,80 @@
+-- This file should serve as an example of my uncommitted secrets.lua file
+-- that contains values that I deem too sensitive to include in committed files.
+-- My hope is that by providing context and examples my Hammerspoon configuration
+-- could be useful to more people.
+secrets = {}
+
+-- Elgato ================================================================== {{{
+-- I use Elgato Key Lights when I have my camera on for Zoom meetings. These IPs
+-- are used in app-config/elgato.lua as the Key Lights expose an API endpoint on
+-- port 9123 where you can turn the lights on and off. I find this to be a much
+-- more reiable way to interact with them instead  of using something like
+-- AppleScript interacting with the Elgato application.
+
+secrets.elgato = {}
+secrets.elgato.ips = { "xxx.xxx.xxx.xxx", "yyy.yyy.yyy.yyy" }
+-- ========================================================================= }}}
+
+-- URLDispatcher =========================================================== {{{
+
+--
+
+secrets.urls = {}
+secrets.urls.builtin = "/Applications/Safari.app"
+secrets.urls.videoPlayer = ""
+-- I use different default browsers on my work and personal machines.
+if Local.env ~= "work" then
+    secrets.urls.default = ""
+    _log("Loaded personal browser secrets.")
+else
+    secrets.urls.meetings = ""
+    secrets.urls.default = ""
+    _log("Loaded work browser secrets.")
+end
+-- ========================================================================= }}}
+
+-- Elgato ================================================================== {{{
+
+--
+
+secrets.audioControl = {}
+secrets.audioControl.headphoneOutput = "Headphone Bluetooth Name"
+secrets.audioControl.internalOutput = "MacBook Speakers"
+secrets.audioControl.monitorOutput = ""
+secrets.audioControl.internalMic = "MacBook Microphone"
+secrets.audioControl.externalMic = ""
+-- ========================================================================= }}}
+
+-- Charging ================================================================ {{{
+secrets.charging = {}
+secrets.charging.toggleContainers = { "container1", "container2", "containerN" }
+-- ========================================================================= }}}
+
+-- Docking Station ========================================================= {{{
+secrets.dock = {}
+secrets.dock.dock = "Dock USB Name"
+secrets.dock.LAN = "Dock NIC Name"
+secrets.dock.mouseID = "Mouse Bluetooth MAC address"
+secrets.dock.dockedApps = {"Docked App 1", "Docked App 2"} -- Do not use `/Applications/`` prefix here
+-- ========================================================================= }}}
+
+-- Mail Application ======================================================== {{{
+secrets.mail = {}
+secrets.mail.companionApps = {"Mail App 1"} -- Do not use `/Applications/` prefix here
+-- ========================================================================= }}}
+
+-- Wifi & Networking ================-====================================== {{{
+secrets.networking = {}
+secrets.networking.homeSSID = "Home SSID"
+secrets.networking.workSSID = "Work SSID"
+secrets.networking.officeSSID = ""
+secrets.networking.phoneSSID = ""
+secrets.networking.captiveSSIDs = {"DeltaSkyClub", "Alaska WiFi", "IHG Connect", "@Hyatt_WiFi"}
+secrets.networking.homeDNS = "192.168.xxx.xxx" -- Local DNS resolver
+secrets.networking.publicDNS = "1.1.1.1" -- Public DNS resolver
+secrets.networking.link = ""
+-- ========================================================================= }}}
+
+_log("Secrets loaded.")
+
+-- vi: ft=lua