documentation updates (#381)

Author: jedib0t

list/README.md

@@ -1,18 +1,9 @@
-## List
+# List
 [![Go Reference](https://pkg.go.dev/badge/github.com/jedib0t/go-pretty/v6/list.svg)](https://pkg.go.dev/github.com/jedib0t/go-pretty/v6/list)
 
 Pretty-print lists with multiple levels/indents into ASCII/Unicode strings.
 
-  - Append Items one-by-one or as a group
-  - Indent/UnIndent as you like
-  - Support Items with Multiple-lines
-  - Mirror output to an io.Writer object (like os.StdOut)
-  - Completely customizable styles
-    - Many ready-to-use styles: [style.go](style.go)
-  - Render as:
-    - (ASCII/Unicode) List
-    - HTML List (with custom CSS Class)
-    - Markdown List
+## Sample List Output
 
 ```
  ■ Game Of Thrones
@@ -28,3 +19,56 @@ Pretty-print lists with multiple levels/indents into ASCII/Unicode strings.
 
 A demonstration of all the capabilities can be found here:
 [../cmd/demo-list](../cmd/demo-list)
+
+## Features
+
+### Core List Building
+
+  - Append items one-by-one or as a group
+  - Support items with multiple lines (newlines preserved)
+  - Automatic handling of tabs (converted to spaces)
+  - Reset list to initial state for reuse
+
+### Indentation Control
+
+  - Indent following items to create nested levels
+  - UnIndent to move back to previous level
+  - UnIndentAll to return to root level
+  - Smart indentation prevents invalid nesting
+
+### Rendering Formats
+
+  - **ASCII/Unicode List** - Human-readable pretty format with customizable bullets and connectors
+  - **HTML List** - Generate nested `<ul>` and `<li>` elements with custom CSS classes
+    - Automatic CSS class numbering for nested levels (e.g., `class-1`, `class-2`)
+    - HTML entity escaping for safe rendering
+    - Multi-line support with `<br/>` tags
+  - **Markdown List** - Generate markdown-compatible list format
+    - Automatically uses markdown-appropriate styling
+
+### Customization & Styling
+
+  - Completely customizable styles
+    - Many ready-to-use styles: [style.go](style.go)
+      - `StyleDefault` - Simple asterisk bullets (*)
+      - `StyleBulletCircle` - Circle bullets (●)
+      - `StyleBulletFlower` - Flower bullets (✽)
+      - `StyleBulletSquare` - Square bullets (■)
+      - `StyleBulletStar` - Star bullets (★)
+      - `StyleBulletTriangle` - Triangle bullets (▶)
+      - `StyleConnectedBold` - Bold box-drawing connectors (┏━, ┣━, ┗━)
+      - `StyleConnectedDouble` - Double box-drawing connectors (╔═, ╠═, ╚═)
+      - `StyleConnectedLight` - Light box-drawing connectors (┌─, ├─, └─)
+      - `StyleConnectedRounded` - Rounded box-drawing connectors (╭─, ├─, ╰─)
+      - `StyleMarkdown` - Markdown-compatible styling
+    - Customize bullet characters for different positions (top, first, middle, bottom, single)
+    - Customize vertical connectors between levels
+    - Set line prefix for all lines
+    - Apply text formatting (colors, styles) using `text.Format`
+  - HTML CSS class customization for styled HTML output
+
+### Output Control
+
+  - Mirror output to an io.Writer object (like os.StdOut) while rendering
+  - Get rendered output as string for further processing
+  - Length() method to get the number of items in the list

progress/README.md

@@ -4,23 +4,70 @@
 Track the Progress of one or more Tasks (like downloading multiple files in
 parallel).
 
+## Sample Progress Tracking
+
+<img src="images/demo.gif" width="640px"/>
+
+A demonstration of all the capabilities can be found here:
+[../cmd/demo-progress](../cmd/demo-progress)
+
+## Features
+
+### Core Tracking
+
   - Track one or more Tasks at the same time
+  - Support for both determinate (with Total) and indeterminate (without Total)
+    trackers
+  - Error tracking with `MarkAsErrored()` for failed tasks
+  - ETA (Estimated Time of Arrival) calculation for each tracker
+  - Speed calculation (items/bytes per second) with customizable formatters
+  - Overall progress tracker that aggregates progress across all trackers
+
+### Tracker Management
+
   - Dynamically add one or more Task Trackers while `Render()` is in progress
+  - Sort trackers by Message, Percentage, or Value (ascending/descending)
+  - Tracker options
+    - `DeferStart` - Delay tracker start until manually triggered
+    - `RemoveOnCompletion` - Hide tracker when done instead of showing completion
+    - `AutoStopDisabled` - Prevent auto-completion when value exceeds total
+
+### Display & Rendering
+
   - Choose to have the Writer auto-stop the Render when no more Trackers are
     in queue, or manually stop using `Stop()`
   - Redirect output to an io.Writer object (like os.StdOut)
+  - Pinned messages that stay visible above all trackers
+  - Log messages during rendering that appear temporarily
+  - Automatic terminal width detection to prevent line wrapping
+  - Flexible tracker positioning (left or right of message)
+  - Configurable update frequency for smooth rendering
+
+### Customization & Styling
+
   - Completely customizable styles
     - Many ready-to-use styles: [style.go](style.go)
+      - `StyleDefault` - ASCII characters
+      - `StyleBlocks` - UNICODE Block Drawing characters
+      - `StyleCircle` - UNICODE Circle runes
+      - `StyleRhombus` - UNICODE Rhombus runes
     - Colorize various parts of the Tracker using `StyleColors`
     - Customize how Trackers get rendered using `StyleOptions`
+    - Control visibility of components (ETA, Speed, Time, Value, etc.)
+    - Custom renderers for determinate and indeterminate progress bars
+  - Multiple indeterminate indicator animations
+    - Moving back and forth
+    - Moving left to right
+    - Moving right to left
+    - Dominoes effect
+    - Pac-Man chomping animation
+    - Colored variants
 
-A demonstration of all the capabilities can be found here:
-[../cmd/demo-progress](../cmd/demo-progress)
-
-## Sample Progress Tracking
-
-<img src="images/demo.gif" width="640px"/>
-
-# TODO
+### Units & Formatting
 
-  - Optimize CPU and Memory Usage
+  - Built-in unit formatters
+    - `UnitsDefault` - Regular numbers (K, M, B, T, Q notation)
+    - `UnitsBytes` - Storage units (B, KB, MB, GB, TB, PB)
+    - `UnitsCurrencyDollar` - Dollar amounts ($x.yzK, etc.)
+    - `UnitsCurrencyEuro` - Euro amounts (₠x.yzK, etc.)
+    - `UnitsCurrencyPound` - Pound amounts (£x.yzK, etc.)

progress/progress_test.go

@@ -255,3 +255,36 @@ func TestProgress_OverallTrackerDisappearsCase(t *testing.T) {
 
 	assert.Equal(t, false, p.overallTracker.IsDone())
 }
+
+func TestProgress_watchTerminalSize(t *testing.T) {
+	p := &Progress{}
+	// Set up a cancellable context for watchTerminalSize
+	p.renderContext, p.renderContextCancel = context.WithCancel(context.Background())
+
+	// Call watchTerminalSize in a goroutine
+	done := make(chan bool)
+	go func() {
+		p.watchTerminalSize()
+		done <- true
+	}()
+
+	// Wait a bit to let the ticker fire at least once (covers case <-ticker.C)
+	time.Sleep(150 * time.Millisecond)
+	p.renderContextCancel()
+
+	// Wait for the goroutine to exit (with timeout)
+	select {
+	case <-done:
+		// Success: goroutine exited after context cancellation
+	case <-time.After(1 * time.Second):
+		t.Fatal("watchTerminalSize goroutine did not exit after context cancellation")
+	}
+
+	// Verify the context was cancelled
+	select {
+	case <-p.renderContext.Done():
+		// Context is cancelled, which is expected
+	default:
+		t.Fatal("Expected context to be cancelled")
+	}
+}