Add crate metadata and documentation

Author: arferreira

CONTRIBUTING.md

@@ -0,0 +1,53 @@
+# Contributing to loshell
+
+Thanks for wanting to help improve loshell.
+
+## Getting Started
+
+```bash
+git clone https://github.com/arferreira/loshell.git
+cd loshell
+cargo run
+```
+
+## What We're Looking For
+
+- New radio stations (must be direct HTTP streams, no YouTube)
+- UI improvements (keeping it minimal)
+- Bug fixes
+- Performance improvements
+- Platform support (Windows, etc.)
+
+## Pull Requests
+
+1. Fork the repo
+2. Create a branch (`git checkout -b feature/your-thing`)
+3. Make your changes
+4. Run `cargo fmt` and `cargo clippy`
+5. Commit with a clear message
+6. Push and open a PR
+
+Keep PRs focused. One feature or fix per PR.
+
+## Code Style
+
+- Run `cargo fmt` before committing
+- No warnings from `cargo clippy`
+- Keep it simple - this is a small focused tool
+
+## Adding Stations
+
+Stations live in `src/radio.rs`. To add one:
+
+```rust
+Station {
+    name: "Station Name",
+    url: "https://direct-stream-url.mp3",
+},
+```
+
+Make sure the stream is reliable and publicly accessible.
+
+## Questions?
+
+Open an issue.

Cargo.toml

@@ -2,6 +2,17 @@
 name = "loshell"
 version = "0.1.0"
 edition = "2024"
+description = "A terminal-native ambient environment for deep focus with lofi radio and pomodoro"
+license = "MIT"
+repository = "https://github.com/arferreira/loshell"
+homepage = "https://github.com/arferreira/loshell"
+keywords = ["tui", "lofi", "pomodoro", "focus", "terminal"]
+categories = ["command-line-utilities"]
+readme = "README.md"
+
+[[bin]]
+name = "loshell"
+path = "src/main.rs"
 
 [dependencies]
 ratatui = "0.30.0"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antonio Souza
+
+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

@@ -1,12 +1,61 @@
-# Loshell
+# loshell
 
 A room for your mind, inside your terminal.
 
-Loshell is a terminal-native ambient environment for deep focus.
-It blends lofi audio, subtle ambience, and focus cycles into a calm,
-distraction-free shell experience.
+Loshell is a terminal-native ambient environment for deep focus. It blends lofi radio streams, a pomodoro timer, and a minimal interface into a calm, distraction-free experience.
 
 Enter the room. Set the cycle. Drift into focus.
 
-Early stage — core engine in progress.
+## Install
 
+```bash
+cargo install loshell
+```
+
+Or via Homebrew:
+
+```bash
+brew tap arferreira/tap
+brew install loshell
+```
+
+## Usage
+
+```bash
+loshell
+```
+
+### Keybindings
+
+| Key | Action |
+|-----|--------|
+| `q` | Quit |
+| `s` | Play/stop radio |
+| `←/→` | Switch station |
+| `p` | Toggle pomodoro |
+| `space` | Start/pause timer |
+| `r` | Reset timer |
+| `+` | Add 5 minutes |
+
+### Stations
+
+- Chillout
+- Lounge
+- Relax FM
+- Smooth Jazz
+- Ambient
+
+## The Story
+
+This project was built through vibe coding sessions: Opus 4.5, neovim, and way too much coffee. The idea was simple: I wanted a focused environment that lives in the terminal, where I already spend most of my time.
+
+No browser tabs. No distractions. Just music, a timer, and the work.
+
+## Requirements
+
+- macOS or Linux
+- Audio output device
+
+## License
+
+MIT