Fixed spelling error

baalimago · Oct 19, 2024 · a3bd5af · a3bd5af
1 parent 711d423
commit a3bd5af
Showing 1 changed file with 34 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
 # (w)eb (d)evelopment-(41)
+
 [![Go Report Card](https://goreportcard.com/badge/github.com/baalimago/wd-41)](https://goreportcard.com/report/github.com/baalimago/wd-41)
 [![wakatime](https://wakatime.com/badge/user/018cc8d2-3fd9-47ef-81dc-e4ad645d5f34/project/3bc921ec-dc23-4222-bf00-578f2eda0cbd.svg)](https://wakatime.com/badge/user/018cc8d2-3fd9-47ef-81dc-e4ad645d5f34/project/3bc921ec-dc23-4222-bf00-578f2eda0cbd)
 
@@ -7,52 +8,57 @@ Test coverage: 76.220% 😌👏
 This is a simple static webserver which live reloads your web-browser on changes to the hosted files.
 
 ## Usage
+
 `wd-41 s|serve <relative directory>` or `wd-41 s|serve` for hosting the current work directory
 
 ## Getting started
+
 ```bash
 go install github.com/baalimago/wd-41@latest
 ```
 
 You may also use the setup script:
+
 ```bash
 curl -fsSL https://raw.githubusercontent.com/baalimago/wd-41/main/setup.sh | sh
 ```
 
 ## Architecture
-1. First the content of the website is copied to a temporary directory, this is the _mirrored content_ 
-1. Every mirrored file is inspectd for type, if it's text/html, a `delta-streamer.js` script is injected
+
+1. First the content of the website is copied to a temporary directory, this is the _mirrored content_
+1. Every mirrored file is inspected for type, if it's text/html, a `delta-streamer.js` script is injected
 1. The web server is started, hosting the _mirrored_ content
 1. The `delta-streamer.js` in turn sets up a websocket connection to the wd-41 webserver
 1. The original file system is monitored, on any file changes:
-    1. the new file is copied to the mirror (including injections)
-    1. the file name is propagated to the browser via the websocket
+   1. the new file is copied to the mirror (including injections)
+   1. the file name is propagated to the browser via the websocket
 1. The `delta-streamer.js` script then checks if the current window origin is the updated file. If so, it reloads the page.
+
 ```
-       ┌───────────────┐                                                 
-       │ Web Developer │                                                 
-       └───────┬───────┘                                                 
-               │                                                         
-       [writes <content>]                                                
-               │                                                         
-               ▼                                                         
- ┌─────────────────────────────┐        ┌─────────────────────┐          
- │ website-directory/<content> │        │ file system notify  │          
- └─────────────┬───────────────┘        └─────────┬───────────┘          
-               │                                  │                      
-               │                      [update mirrored content]          
-               ▼                                  │                      
-     ┌────────────────────┐                       │                      
-     │ ws-script injector │◄──────────────────────┘                      
-     └─────────┬──────────┘                                              
-               │                                                         
-               │                                                         
-               ▼                                                         
-   ┌────────────────────────┐                                            
-   │ tmp-abcd1234/<content> │                                            
-   └───────────┬────────────┘                                            
-               │                                                         
-       [serves <content>]                                                
+       ┌───────────────┐
+       │ Web Developer │
+       └───────┬───────┘
+               │
+       [writes <content>]
+               │
+               ▼
+ ┌─────────────────────────────┐        ┌─────────────────────┐
+ │ website-directory/<content> │        │ file system notify  │
+ └─────────────┬───────────────┘        └─────────┬───────────┘
+               │                                  │
+               │                      [update mirrored content]
+               ▼                                  │
+     ┌────────────────────┐                       │
+     │ ws-script injector │◄──────────────────────┘
+     └─────────┬──────────┘
+               │
+               │
+               ▼
+   ┌────────────────────────┐
+   │ tmp-abcd1234/<content> │
+   └───────────┬────────────┘
+               │
+       [serves <content>]
                │                               ┌────────────────────────┐
                ▼                               │         Browser        │
 ┌──────────────────────────────┐               │                        │