feat: update README.md

Author: wislertt

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+    "semi": false,
+    "tabWidth": 4,
+    "trailingComma": "es5",
+    "printWidth": 105
+}

.releaserc.json

@@ -1,8 +1,8 @@
 {
-  "branches": ["main"],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/github"
-  ]
+    "branches": ["main"],
+    "plugins": [
+        "@semantic-release/commit-analyzer",
+        "@semantic-release/release-notes-generator",
+        "@semantic-release/github"
+    ]
 }

Makefile

@@ -8,11 +8,12 @@ setup_dev:
 	pipx install pre-commit
 	pre-commit install
 
-	brew install shfmt shellcheck
+	brew install shfmt shellcheck prettier
 
 assert_setup_dev:
 	pre-commit run -a
 
 lint:
 	find . -type f -name "*.sh" -exec shfmt -w -i 6 {} +
 	find . -type f -name "*.sh" -exec shellcheck {} +
+	prettier --write "**/*.{json,yaml,yml,md}"

README.md

@@ -1,6 +1,6 @@
 # Shared Scripts
 
-Collection of development setup and utility scripts for macOS environments.
+Quick-share command line scripts for use in quick command runner like Makefile or Justfile.
 
 ## Quick Start
 
@@ -11,6 +11,19 @@ make assert_setup_dev  # Validate setup
 
 ## Requirements
 
--   macOS
--   Homebrew
--   Zsh shell
+- macOS
+- Homebrew
+- Zsh shell
+
+## Usage
+
+```bash
+git submodule add -b main https://github.com/wisarootl/shared-scripts.git scripts/shared
+```
+
+```Makefile
+setup_dev:
+	chmod +x scripts/shared/node/setup_dev.sh
+	./scripts/shared/node/setup_dev.sh
+	exec zsh
+```