Skip to content

Commit a4effb9

Browse files
author
Chris Funderburg
committed
docs: update README with new features and usage instructions
1 parent 59230af commit a4effb9

2 files changed

Lines changed: 11 additions & 2 deletions

File tree

Makefile

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
.PHONY: dev build clean test preview install lint
1+
.PHONY: dev build clean test preview install lint release
22

33
## Start development server
44
dev:
@@ -31,3 +31,7 @@ install:
3131
## Preview production build locally
3232
preview: build
3333
npx vite preview
34+
35+
## Bump version, update CHANGELOG.md, commit and tag
36+
release:
37+
npm run release

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,10 @@ UltraFormat is the alternative. It's a single-page React app that you build once
3030
| **URL Codec** | Encode, decode & parse URLs with automatic query string breakdown |
3131
| **JWT Decoder** | Decode JSON Web Tokens and inspect headers, payloads, and claims |
3232
| **Color Converter** | Convert between HEX, RGB, and HSL with a live preview swatch and sliders |
33+
| **Lorem Generator** | Generate classic or hipster lorem ipsum by paragraphs, sentences, or words |
34+
| **Hash Generator** | Compute MD5, SHA-1, SHA-256, and SHA-512 hashes client-side |
35+
| **UUID Generator** | Bulk-generate v4 UUIDs with uppercase and no-dashes options |
36+
| **Timestamp Converter** | Convert Unix timestamps to human dates and back, with a live clock |
3337

3438
## Features
3539

@@ -38,7 +42,7 @@ UltraFormat is the alternative. It's a single-page React app that you build once
3842
- **Accessible** — WCAG-compliant contrast, `prefers-reduced-motion` support, keyboard navigation, focus indicators, screen reader–friendly markup
3943
- **Fast** — sub-second load, no external API calls, no spinners
4044
- **Responsive** — works on desktop and tablet viewports
41-
- **121 unit tests** — across all tools and components
45+
- **149 unit tests** — across all tools and components
4246
- **Zero cookies, zero analytics, zero ads**
4347

4448
## Tech Stack
@@ -78,6 +82,7 @@ make test # run unit tests
7882
make build # type-check + production build
7983
make preview # build then preview at localhost:4173
8084
make clean # remove dist/ and Vite caches
85+
make release # bump version, update CHANGELOG.md, commit and tag
8186
```
8287

8388
## Production Build

0 commit comments

Comments
 (0)