mirror of
https://github.com/Xevion/time-banner.git
synced 2025-12-06 11:16:41 -06:00
chore: edit README, feature planning
This commit is contained in:
36
README.md
36
README.md
@@ -2,23 +2,27 @@
|
|||||||
|
|
||||||
My first Rust project, intended to offer a simple way to display the current time relative, in an image format.
|
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
|
- [ ] Dynamic light/dark mode
|
||||||
- Via Query Parameters for Raster or SVG
|
- [ ] Via Query Parameters for Raster or SVG
|
||||||
- Via CSS for SVG
|
- [ ] Via CSS for SVG
|
||||||
- Relative or Absolute Format
|
- [x] Relative or Absolute Format
|
||||||
- Dynamic Formats
|
- [ ] Dynamic Formats (currently basic template only)
|
||||||
- Caching Abilities
|
- [ ] Caching Abilities
|
||||||
- Relative caching for up to 59 seconds, purged on the minute
|
- [ ] Relative caching for up to 59 seconds, purged on the minute
|
||||||
- Absolute caching for up to 50MB, purged on an LRU basis
|
- [ ] Absolute caching for up to 50MB, purged on an LRU basis
|
||||||
- Flexible & Dynamic Browser API
|
- [x] Flexible & Dynamic Browser API
|
||||||
- Allow users to play with format in numerous ways to query API
|
- [x] Basic routing with multiple formats
|
||||||
- Examples
|
- [x] SVG and PNG output support
|
||||||
- `/svg/2023-06-14-3PM-CST`
|
- [ ] JPEG/WebP support
|
||||||
- `2023-06-14-3PM-CST.svg`
|
- [ ] Query parameter support (`?format=`, `?tz=`)
|
||||||
- `/jpeg/2023.06.14.33` (14th of June, 2023, 2:33 PM UTC)
|
- [x] Timezone Support
|
||||||
- `/jpeg/2023.06.14.33T-5` (14th of June, 2023, 2:33 PM UTC-5)
|
- [x] Timezone abbreviation parsing
|
||||||
|
- [x] UTC and offset handling
|
||||||
|
- [x] Error Handling
|
||||||
|
- [x] Comprehensive error responses
|
||||||
|
- [x] Parse, render, and rasterization error handling
|
||||||
|
|
||||||
## Routes
|
## Routes
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user