docs: refactor documentation structure and add MIT license

Reorganize documentation to separate user and developer concerns:
- README.md now focuses on end-users (installation, usage, features)
- CONTRIBUTING.md contains all development information (architecture,
  performance, testing, dependencies, workflows)
- Removed cargo commands from user-facing docs
- Added MIT LICENSE file
- Updated Cargo.toml with package metadata (license, description,
  repository, keywords, categories)
- Fixed edition from 2024 to 2021

This makes the README cleaner and more accessible for users while
keeping comprehensive development documentation in CONTRIBUTING.md.

Author: raaymax

CONTRIBUTING.md

@@ -27,7 +27,51 @@ cargo test
 
 # Run with a log file
 cargo run -- test.log
+
+# Run in release mode with a log file
+cargo run --release -- test.log
+```
+
+## Project Architecture
+
 ```
+src/
+├── main.rs              # Entry point, CLI, and main event loop
+├── app.rs               # Application state management
+├── reader/
+│   ├── mod.rs          # LogReader trait
+│   └── file_reader.rs  # Lazy file reader with line indexing
+├── filter/
+│   ├── mod.rs          # Filter trait
+│   ├── engine.rs       # Background filtering engine
+│   ├── regex_filter.rs # Regex filter implementation
+│   └── string_filter.rs# String matching filter
+├── ui/
+│   └── mod.rs          # ratatui rendering logic
+└── watcher.rs          # File watching with inotify
+```
+
+For detailed architecture documentation, see `CLAUDE.md`.
+
+## Performance Characteristics
+
+The viewer is designed to handle large log files efficiently:
+- **Line indexing**: O(n) one-time indexing, then O(1) random access
+- **Viewport rendering**: Only renders visible lines
+- **Background filtering**: Non-blocking filter execution in separate thread
+- **Memory usage**: ~constant regardless of file size (only viewport buffer in RAM)
+- **Incremental filtering**: Only filters new log lines when file grows
+
+## Dependencies
+
+- **ratatui** - TUI framework
+- **crossterm** - Cross-platform terminal manipulation
+- **notify** - File system watching
+- **regex** - Regular expression support
+- **serde_json** - JSON parsing
+- **clap** - CLI argument parsing
+- **anyhow** - Error handling
+- **ansi-to-tui** - ANSI escape code parsing and color rendering
 
 ### Development Tools
 
@@ -40,10 +84,41 @@ cargo fmt -- --check
 
 # Format code
 cargo fmt
+```
+
+## Testing
 
-# Generate test logs
+### Test Log Files
+
+The repository includes test log files and generators:
+- `test.log` - Plain text logs with various log levels (INFO, DEBUG, WARN, ERROR)
+- `generate_logs.sh` - Script to generate plain text logs continuously
+- `generate_colored_logs.sh` - Script to generate ANSI-colored logs continuously
+
+### Testing Live Reload and Follow Mode
+
+Test the file watching feature:
+
+```bash
+# Terminal 1: Start generating logs
 ./generate_logs.sh live_test.log
+
+# Terminal 2: Watch the logs in real-time
+cargo run --release -- live_test.log
+```
+
+Press `f` to enable follow mode and watch new lines scroll into view automatically.
+
+### Testing with Colored Logs
+
+Test ANSI color support:
+
+```bash
+# Terminal 1: Generate colored logs
 ./generate_colored_logs.sh live_test_colored.log
+
+# Terminal 2: View the logs with full color rendering
+cargo run --release -- live_test_colored.log
 ```
 
 ## Commit Convention

Cargo.toml

@@ -1,7 +1,13 @@
 [package]
 name = "lazytail"
 version = "0.1.0"
-edition = "2024"
+edition = "2021"
+authors = ["raaymax"]
+license = "MIT"
+description = "A terminal-based log viewer with filtering capabilities"
+repository = "https://github.com/raaymax/lazytail"
+keywords = ["log", "viewer", "tui", "terminal", "tail"]
+categories = ["command-line-utilities", "development-tools"]
 
 [dependencies]
 ratatui = "0.29"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 raaymax
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -38,29 +38,8 @@ A terminal-based log viewer with filtering capabilities, built with Rust and rat
 **General:**
 - `q` or `Ctrl+C` - Quit
 
-## Architecture
-
-```
-src/
-├── main.rs              # Entry point, CLI, and main event loop
-├── app.rs               # Application state management
-├── reader/
-│   ├── mod.rs          # LogReader trait
-│   └── file_reader.rs  # Lazy file reader with line indexing
-├── filter/
-│   ├── mod.rs          # Filter trait
-│   ├── engine.rs       # Background filtering engine
-│   ├── regex_filter.rs # Regex filter implementation
-│   └── string_filter.rs# String matching filter
-├── ui/
-│   └── mod.rs          # ratatui rendering logic
-└── watcher.rs          # File watching with inotify
-```
-
 ## Installation
 
-### Download Pre-built Binaries
-
 Download the latest release for your platform from the [Releases page](https://github.com/raaymax/lazytail/releases):
 
 ```bash
@@ -83,28 +62,14 @@ chmod +x lazytail
 sudo mv lazytail /usr/local/bin/
 ```
 
-### Build from Source
-
-```bash
-git clone https://github.com/raaymax/lazytail.git
-cd lazytail
-cargo build --release
-sudo cp target/release/lazytail /usr/local/bin/
-```
+For building from source, see [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## Usage
 
-Run the application with a log file:
+Run LazyTail with a log file:
 
 ```bash
-cargo run --release -- test.log
-```
-
-Or build and run the binary:
-
-```bash
-cargo build --release
-./target/release/lazytail test.log
+lazytail /path/to/your/logfile.log
 ```
 
 ### Command Line Options
@@ -130,60 +95,25 @@ Options:
 
 The filter searches through all lines in the background without blocking the UI, so even with large files the interface remains responsive.
 
-### Testing Live Reload and Follow Mode
-
-Test the file watching feature with the included log generator:
-
-```bash
-# Terminal 1: Start generating logs
-./generate_logs.sh live_test.log
-
-# Terminal 2: Watch the logs in real-time
-cargo run --release -- live_test.log
-```
+### Using Follow Mode
 
-**Using Follow Mode:**
+**Follow Mode** allows you to automatically scroll to new log lines as they're written to the file (like `tail -f`):
 1. Press `f` to enable follow mode - the status bar will show "FOLLOW"
 2. New log lines will automatically scroll into view as they arrive
 3. Press `f` again to disable follow mode and manually navigate
 4. Any manual scroll action (↑/↓/PgUp/PgDn/g/G) automatically disables follow mode
 
-New log lines will appear automatically as they're written to the file. File watching is enabled by default, but you can disable it with `--no-watch` if needed.
-
-### Testing with Colored Logs
-
-Test with ANSI-colored logs using the colored log generator:
+File watching is enabled by default, so new log lines will appear automatically as they're written to the file. You can disable it with `--no-watch` if needed.
 
-```bash
-# Terminal 1: Generate colored logs
-./generate_colored_logs.sh live_test_colored.log
-
-# Terminal 2: View the logs with full color rendering
-cargo run --release -- live_test_colored.log
-```
+### ANSI Color Support
 
-The viewer parses ANSI escape codes and renders them in full color! Colored logs from other tools (like `docker logs`, `kubectl logs`, or application logs with color formatting) display beautifully:
+LazyTail parses ANSI escape codes and renders them in full color! Colored logs from other tools (like `docker logs`, `kubectl logs`, or application logs with color formatting) display beautifully:
 - **Green** for INFO
 - **Cyan** for DEBUG
 - **Yellow** for WARN
 - **Red** for ERROR
 - Plus all other ANSI colors and styles (bold, dim, etc.)
 
-## Testing
-
-Test log files are included:
-- `test.log` - Plain text logs with various log levels (INFO, DEBUG, WARN, ERROR)
-- `generate_logs.sh` - Script to generate plain text logs
-- `generate_colored_logs.sh` - Script to generate ANSI-colored logs
-
-## Performance
-
-The viewer is designed to handle large log files efficiently:
-- **Line indexing**: O(n) one-time indexing, then O(1) random access
-- **Viewport rendering**: Only renders visible lines
-- **Background filtering**: Non-blocking filter execution in separate thread
-- **Memory usage**: ~constant regardless of file size (only viewport buffer in RAM)
-
 ## Upcoming Features
 
 - [x] File watching with auto-reload (inotify)
@@ -200,17 +130,6 @@ The viewer is designed to handle large log files efficiently:
 - [ ] Case-sensitive filter toggle
 - [ ] Bookmark lines
 
-## Dependencies
-
-- **ratatui** - TUI framework
-- **crossterm** - Cross-platform terminal manipulation
-- **notify** - File system watching
-- **regex** - Regular expression support
-- **serde_json** - JSON parsing
-- **clap** - CLI argument parsing
-- **anyhow** - Error handling
-- **ansi-to-tui** - ANSI escape code parsing and color rendering
-
 ## Contributing
 
 Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for:
@@ -219,3 +138,7 @@ Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for:
 - CI/CD workflow documentation
 - Release process
 - Pull request guidelines
+
+## License
+
+LazyTail is licensed under the [MIT License](LICENSE).