doc: update README

Author: nicokant

README.md

@@ -1,82 +1,64 @@
-# s3-explorer
+# S3 Explorer
 
-## Setup
-Install `uv`: https://docs.astral.sh/uv/getting-started/installation/
+A Streamlit-based web application for exploring S3-compatible storage buckets and previewing their contents.
 
-```bash
-git init
-uv sync --dev
-git add .
-git commit -m "Initial commit"
-uv run pre-commit install # optional
-```
+## Features
 
+- **Browse S3 Buckets**: Select from configured buckets and view all objects with path, size, and last modified date
+- **Search**: Filter objects by path with case-insensitive search
+- **File Preview**:
+  - **Images**: Preview PNG, JPG, JPEG, GIF, WebP, and SVG files
+  - **GeoParquet**: Visualize geospatial data on an interactive Folium map (first 2000 features)
+  - **Parquet**: Display tabular data
+  - **Text files**: Syntax-highlighted preview for TXT, MD, JSON, YAML, CSV, and XML
+  - **Other files**: Download button for unsupported formats
+- **Anonymous Access**: Supports S3 buckets without authentication
+- **Cache Management**: Refresh bucket contents with a single click
 
-### Run
-To execute your software you have two options:
+## Setup
 
-**Option 1: Direct execution**
-```bash
-uv run main.py
-```
+Install [uv](https://docs.astral.sh/uv/getting-started/installation/), then:
 
-**Option 2: Run as installed package**
 ```bash
-uvx --from . s3-explorer
+uv sync
 ```
 
-### Development
-Just run `uv run main.py` and you are good to go!
+## Configuration
 
-### Update from template
-To update your project with the latest changes from the template, run:
-```bash
-uvx --with copier-template-extensions copier update --trust
-```
+Copy the example config and edit it:
 
-You can keep your previous answers by using:
 ```bash
-uvx --with copier-template-extensions copier update --trust --defaults
+cp config.example.yaml config.yaml
 ```
 
-### (Optional) pre-commit
-pre-commit is a set of tools that help you ensure code quality. It runs every time you make a commit.
+Configure your buckets in `config.yaml`:
 
-First, install pre-commit:
-```bash
-uv tool install pre-commit
+```yaml
+buckets:
+  my-bucket:
+    endpoint: https://s3.amazonaws.com
+    bucket: actual-bucket-name  # optional, defaults to the key name
+    access_key: your-access-key  # optional, omit for anonymous access
+    secret_key: your-secret-key
 ```
 
-Then install pre-commit hooks:
-```bash
-pre-commit install
-```
+You can also set the config path via environment variable:
 
-To run pre-commit on all files:
 ```bash
-pre-commit run --all-files
+export S3_EXPLORER_CONFIG=/path/to/config.yaml
 ```
 
-### How to install a package
-Run `uv add <package-name>` to install a package. For example:
+## Run
+
 ```bash
-uv add requests
+uv run streamlit run app.py
 ```
 
-#### Visual studio code
-If you are using visual studio code install the recommended extensions
+Then open http://localhost:8501 in your browser.
 
+## Docker
 
-### Tools installed
-- uv
-- pre-commit (optional)
-
-#### What is an environment variable? and why should I use them?
-Environment variables are variables that are not populated in your code but rather in the environment
-that you are running your code. This is extremely useful mainly for two reasons:
-- security, you can share your code without sharing your passwords/credentials
-- portability, you can avoid using hard-coded values like file-system paths or folder names
-
-you can place your environment variables in a file called `.env`, the `main.py` will read from it. Remember to:
-- NEVER commit your `.env`
-- Keep a `.env.example` file updated with the variables that the software expects
+Build and run with Docker:
+```bash
+docker compose up
+```