chore: edit README, feature planning

This commit is contained in:
2025-07-10 10:06:04 -05:00
parent 0cb32482fa
commit 56777038a0

View File

@@ -2,23 +2,27 @@
My first Rust project, intended to offer a simple way to display the current time relative, in an image format.
## Planned Features
## Features
- Dynamic light/dark mode
- Via Query Parameters for Raster or SVG
- Via CSS for SVG
- Relative or Absolute Format
- Dynamic Formats
- Caching Abilities
- Relative caching for up to 59 seconds, purged on the minute
- Absolute caching for up to 50MB, purged on an LRU basis
- Flexible & Dynamic Browser API
- Allow users to play with format in numerous ways to query API
- Examples
- `/svg/2023-06-14-3PM-CST`
- `2023-06-14-3PM-CST.svg`
- `/jpeg/2023.06.14.33` (14th of June, 2023, 2:33 PM UTC)
- `/jpeg/2023.06.14.33T-5` (14th of June, 2023, 2:33 PM UTC-5)
- [ ] 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
## Routes