docs: cleanup README

README.md

@@ -1,31 +1,6 @@
 # time-banner
 
-My first Rust project, intended to offer a simple way to display the current time relative, in an image format.
+Dynamically generated timestamp images
-
-## Features
-
-- [ ] Dynamic light/dark mode
-  - [ ] Via Query Parameters for Raster or SVG
-  - [ ] Via CSS for SVG
-- [x] Relative or Absolute Format
-- [ ] Dynamic Formats (currently basic template only)
-- [ ] Caching Abilities
-  - [ ] Relative caching for up to 59 seconds, purged on the minute
-  - [ ] Absolute caching for up to 50MB, purged on an LRU basis
-- [x] Flexible & Dynamic Browser API
-  - [x] Basic routing with multiple formats
-  - [x] SVG and PNG output support
-  - [ ] JPEG/WebP support
-  - [ ] Query parameter support (`?format=`, `?tz=`)
-- [x] Timezone Support
-  - [x] Timezone abbreviation parsing
-  - [x] UTC and offset handling
-- [x] Error Handling
-  - [x] Comprehensive error responses
-  - [x] Parse, render, and rasterization error handling
-- [ ] Dynamic Favicon
-  - [ ] .ico Rendering
-  - [ ] IP to Timezone
 
 ## Routes
 
@@ -67,13 +42,27 @@ My first Rust project, intended to offer a simple way to display the current tim
 
 ## Ideas
 
+- Frontend with React for Demo
+  - Refetch favicon every 10 minutes
+  - Click to copy image URLs
+  - Dynamic Examples
+- Dynamic light/dark mode
+  - `?theme={auto|light|dark}`, default `light`
+  - Customizable SVG templates
+- Dynamic favicon generation
+  - Clock svg optimized for favicon size
+  - Move hands to the current time
+  - Use geolocation of request IP to determine timezone
+  - Advanced: create sun/moon SVG based on local time
 - Support for different timezone formats in query parameters or headers
   - `?tz=...` or `X-Timezone: ...`
   - `CST` or `America/Chicago` or `UTC-6` or `GMT-6` or `-0600`
   - Automatically guessed based on geolocation of source IP address
 - Complex caching abilities
-  - Multi-level caching (disk, memory)
+  - Multi-level caching (disk with max size, memory)
   - Automatic expiry of relative items
+  - Use browser cache headers
+  - Detect force refreshs and allow cache busting
 - `Accept` header support
 - IP-based rate limiting
   - Multi-domain rate limiting factors
@@ -81,40 +70,11 @@ My first Rust project, intended to offer a simple way to display the current tim
     - Base rate: 3 requests per second
 - Cached Conversions
   - If PNG is cached, then JPEG/WEBP/etc. can be converted from cached PNG
-
+- Additional date input formats
-### Query Parameters
+  - 2025-07-10-12:01:14
-
+  - 2025-07-10-12:01
-- `format` - Specify the format of the time string
+  - 2025-07-10-12:01:14-06:00
-- `tz` - Specify the timezone of the time string. May be ignored if the time string contains a timezone/offset.
+  - 2025-07-10-12:01:14-06
-
+  - 2025-07-10-12:01:14-06:00:00
-## Structure
+  - 2025-07-10-12:01:14-06:00:00.000
-
+  - 2025-07-10-12:01:14-06:00:00Z-06:00
-1. Routing
-   - Handle different input formats at the route layer
-2. Parsing
-   - Module for parsing input
-3. Cache Layer
-   - Given all route options, provide a globally available cache for the next layer
-4. SVG Template Rendering
-   - Template rendering based on parsed input
-5. (Optional) Rasterization
-   - If rasterization is requested, render SVG to PNG
-6. (Catch-all) Error Handling
-   - All errors/panics will be caught in separate middleware
-
-## Input Parsing
-
-- Date formatting will be guesswork, but can be specified with `?format=` parameter.
-  - To avoid abuse, it will be limited to a subset of the `chrono` formatting options.
-- The assumed extension when not specified is `.svg` for performance sake.
-  - `.png` is also available. `.jpeg` and `.webp` are planned.
-- Time is not required, but will default each value to 0 (except HOUR, which is the minimum specified value).
-- Millisecond precision is allowed, but will be ignored in most outputs. Periods or commas are allowed as separators.
-- Timezones can be qualified in a number of ways, but will default to UTC if not specified.
-  - Fully qualified TZ identifiers like "America/Chicago" are specified using the `tz` query parameter.
-  - Abbreviated TZ identifiers like "CST" are specified inside the time string, after the time, separated by a dash.
-    - Abbreviated terms are incredibly ambiguous, and should be avoided if possible. For ease of use, they are
-      available, but several of them are ambiguous, and the preferred TZ has been specified in code.
-    - Full table available in [`abbr_tz`](./src/abbr_tz). Comments designated with `#`. Preferred interpretation
-      designated arbitrarily by me. Table sourced
-      from [Wikipedia](https://en.wikipedia.org/wiki/List_of_time_zone_abbreviations)