Skip to content

Commit b2328db

Browse files
authored
QuiltSync README: lead with the vision (tagline + prologue) (#780)
1 parent cdaf7be commit b2328db

1 file changed

Lines changed: 19 additions & 4 deletions

File tree

quilt-sync/README.md

Lines changed: 19 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,24 @@
1-
# QuiltSync
1+
# Cross-platform desktop application for editing Quilt data packages
22

3-
## Cross-platform desktop application for editing Quilt data packages
3+
**QuiltSync keeps your data under revision control and never asks you to
4+
think about it.**
45

5-
Uses Tauri (<https://tauri.app/v1/guides/getting-started/setup/html-css-js>)
6-
to build a Rust application with a web frontend.
6+
Built for bench scientists rather than engineers, QuiltSync lets you find a
7+
data package in the Quilt Web Catalog, open it on your desktop, and bring
8+
down only the files you need — not the whole package — into an ordinary
9+
local folder.
10+
11+
Edit them in your usual tools and QuiltSync syncs your changes back as a new
12+
revision, so getting data in and out never means the command line or
13+
uploading file copies through the browser.
14+
15+
Every revision is an immutable, reproducible snapshot with its metadata —
16+
versioned data you can trust and return to, not the opaque mirroring of
17+
ordinary file-sync.
18+
19+
Your team's existing rules still apply: each revision conforms to the
20+
workflow configured for its bucket and reuses the same roles and policies
21+
you already have in the Catalog — nothing new to set up.
722

823
## Usage
924

0 commit comments

Comments
 (0)