docs: rewrite README file

This commit is contained in:
Leonardo Murça 2026-04-25 19:34:37 -03:00
parent 7e184d16b0
commit 18f6b1a2c2
2 changed files with 64 additions and 5 deletions

View file

@ -1,14 +1,73 @@
# Embroidery Viewer
# 🧵 Embroidery Viewer
![Logo](/logo.webp)
![Deploy workflow status](https://git.leomurca.xyz/leomurca/embroidery-viewer/actions/workflows/deploy.yml/badge.svg)
A free online tool to view embroidery files.
Available at https://embroideryviewer.xyz.
**The simplest way to preview embroidery files — instantly, in your browser.**
👉 **Try it now:** https://embroideryviewer.xyz
![Demo](/demo.gif)
Current supported formats: **.pes, .dst, .pec, .jef and .exp**.
<a href="https://buymeacoffee.com/embroideryviewerxyz">
<img src="docs/yellow-button.png" width="200" alt="Alt Text">
</a>
Inspired by https://github.com/redteam316/html5-embroidery.git.
---
## ✨ Why Embroidery Viewer?
Working with embroidery files shouldnt require heavy, expensive software.
Embroidery Viewer was built to solve a simple problem:
> _“I just want to quickly see my design.”_
No installs. No friction. Just drag, drop, and view.
---
## 🚀 Features
- ⚡ **Instant preview** — open files in seconds
- 🔒 **Private by design** — everything runs in your browser
- 🧵 **Multiple formats supported**
- 🖥️ **Works on any device** (desktop, tablet, mobile)
- 📂 **Batch-friendly** — view multiple files in sequence
---
## 📁 Supported Formats
- `.pes`
- `.dst`
- `.pec`
- `.jef`
- `.exp`
---
## 🧠 How it works
All processing happens **client-side** using modern web technologies.
Your files are never uploaded to any server.
---
## 💡 Inspiration
Inspired by:
https://github.com/redteam316/html5-embroidery.git
---
## ❤️ Support the project
If this tool helped you, consider supporting its development:
- Share it with others
- Give feedback
- Or contribute to the project
---

BIN
docs/yellow-button.png Executable file

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB