Docs touchups (#10)

This pull request delivers significant improvements to documentation,
shell completions, and configuration for the `smoosh` project. The
README has been rewritten for clarity and conciseness, with improved
installation, usage, and feature documentation. Additionally, new shell
autocompletion scripts for Bash, Zsh, and Fish have been added, making
the CLI more user-friendly. Minor configuration adjustments were made to
`.editorconfig` and `.gitattributes` for consistency and better handling
of files.

**Documentation improvements:**

- Major rewrite and simplification of `README.md`: clearer quick start,
installation, usage, and feature sections; improved AI tool integration
guides; more concise FAQ; and better formatting throughout.
[[1]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L12-R18)
[[2]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L33-R64)
[[3]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L90-R133)
[[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L233-R168)
[[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L253-R193)
[[6]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L357-R283)
- Minor cleanup in `CONTRIBUTING.md` for clarity.

**Shell completions:**

- Added Bash (`completions/smoosh.bash`), Zsh
(`completions/smoosh.zsh`), and Fish (`completions/smoosh.fish`)
autocompletion scripts to enhance CLI usability.
[[1]](diffhunk://#diff-a850d66a2d2ef59e18a2f76c58977bbc36cfc2ec0568242c92bda2beaf61cd2eR1-R36)
[[2]](diffhunk://#diff-6137cce49420e6806303fc3a742b35ad6a316238f00825515cac0b63160df9b8R1-R33)
[[3]](diffhunk://#diff-8f1c88118d324d7d789f454801779074a65d2e32bccbffc3d46ac1e24119d3b2R1-R24)

**Configuration and housekeeping:**

- Updated `.editorconfig` for consistent whitespace, charset, and
trimming rules.
- Improved `.gitattributes` to better handle line endings, linguist
settings, and to hide golden test outputs from PR diffs and language
stats.

---------

Signed-off-by: K1-R1 <77465250+K1-R1@users.noreply.github.com>

Author: K1-R1

.editorconfig

@@ -1,25 +1,16 @@
 root = true
 
 [*]
-charset = utf-8
 end_of_line = lf
-indent_style = space
-indent_size = 4
-trim_trailing_whitespace = true
 insert_final_newline = true
-max_line_length = 100
-
-[smoosh]
-indent_style = space
-indent_size = 2
-shell_variant = bash
+trim_trailing_whitespace = true
+charset = utf-8
 
 [*.{sh,bash,bats}]
 indent_style = space
 indent_size = 2
-shell_variant = bash
 
-[*.{yml,yaml}]
+[smoosh]
 indent_style = space
 indent_size = 2
 

.gitattributes

@@ -1,14 +1,6 @@
-# Enforce LF line endings everywhere — prevents CRLF issues on Windows/Git Bash.
 * text=auto eol=lf
+*.sh text eol=lf
+smoosh text eol=lf
 
-# Binary files — do not diff or merge.
-*.png binary
-*.gif binary
-*.jpg binary
-
-# Shell scripts — ensure LF and enable linguist detection.
-*.sh text eol=lf linguist-language=Shell
-smoosh text eol=lf linguist-language=Shell
-
-# Bats test files.
-*.bats text eol=lf linguist-language=Shell
+# Hide golden tests from PR diffs and language stats
+test/golden/** -diff linguist-generated=true

.gitignore

@@ -32,6 +32,10 @@ todos/
 
 # test artefacts
 /tmp/
+coverage/
+
+# release artefacts
+*.sha256
 
 # fixture files that intentionally resemble secrets/env files
 !test/fixtures/golden-repo/.env.example

CONTRIBUTING.md

@@ -1,7 +1,5 @@
 # Contributing to smoosh
 
-Thank you for your interest in contributing!
-
 ## Prerequisites
 
 - Bash 3.2+ (test with `bash --version`)