Skip to content

Commit b3646cf

Browse files
committed
update README for v0.0.6
1 parent bab20b5 commit b3646cf

10 files changed

+23
-11
lines changed

README.md

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ If i messed up a file, i need to search a clean state from the file in the snaps
88

99
# Description
1010

11-
With `zfs-snap-diff` you can explore file differences from different zfs snapshots to the actual file version or browse in old snapshots.
11+
With `zfs-snap-diff` you can explore file differences and restore changes from older file versions in different zfs snapshots.
12+
You can restore the whole file from a older version, or select changes to revert in the 'Diff' view.
1213

1314

1415
`zfs-snap-diff` has a web frontend, so it can run on your local work machine or on your remote file / backup server (no Xserver necesarry).
@@ -18,10 +19,6 @@ The backend is implemented in golang, the frontend with [angularjs](https://angu
1819

1920

2021

21-
*!! it's in a very early dev state - only tested on FreeBSD !!*
22-
23-
24-
2522
#Usage
2623

2724

@@ -79,13 +76,18 @@ When a file is selected, `zsd-snap-diff` search all snapshots where the selected
7976

8077
### Select a snapshot
8178

82-
When you select a snapshot, you can view, diff, download or restore the selected file.
79+
When you select a snapshot, you can view, diff, download or restore the file from the selected snapshot.
8380

8481
#### View
82+
View the file content from an older file version.
8583
![File View](doc/zsd-snap-selected-view-file.png)
8684

8785
#### Diff
88-
![File Diff](doc/zsd-snap-selected-diff-file.png)
86+
Explore file differences and pick changes to revert.
87+
88+
![intext diff](doc/zsd-snap-selected-diff-file-intext.png)
89+
90+
![side by side diff](doc/zsd-snap-selected-diff-file-side-by-side.png)
8991

9092

9193
## Browse snapshot state
@@ -112,9 +114,9 @@ From here you can easy restore / view a deleted file.
112114

113115
<ORG_FILE_NAME>-<SNAPSHOT_NAME>.<FILE_SUFFIX>
114116

115-
* if you restore a file, the orginal file will be renamed as:
117+
* if you restore / patch a file, the orginal file will be saved under:
116118

117-
<ORG_FLILE_NAME>_<TIMESTAMP>
119+
./zsd/<ORG_FLILE_NAME>_<TIMESTAMP>
118120

119121
* for snapshot differences (Browse snapshot diff), you need to set the diff permission:
120122

@@ -142,9 +144,9 @@ From here you can easy restore / view a deleted file.
142144

143145
cd zfs-snap-diff
144146

145-
* fetch dependencies
147+
* fetch dependencies ([go-diff](https://github.com/sergi/go-diff))
146148

147-
go get -u
149+
go get -u
148150

149151
* generate golang src from static web content (this generates bindata.go)
150152

@@ -163,6 +165,16 @@ From here you can easy restore / view a deleted file.
163165
# Changelog
164166

165167
###0.0.X###
168+
169+
0.0.6:
170+
* check if file in snapshot has changed filetype depend:
171+
* text files: md5
172+
* others: size+modTime
173+
* diffs created in the backend (per [go-diff](https://github.com/sergi/go-diff))
174+
* different presentation: intext / side by side
175+
* possibility to revert single changes
176+
* bugfixes
177+
166178

167179
0.0.5:
168180
* file compare method configurable: size+modTime (default) or md5

doc/zsd-file-browser.png

-4.07 KB
Loading

doc/zsd-file-selected.png

9.01 KB
Loading
69.6 KB
Loading
88.5 KB
Loading
-63.8 KB
Binary file not shown.
-8.01 KB
Loading

doc/zsd-snapshots-file-browser.png

32.6 KB
Loading
-29.4 KB
Binary file not shown.

doc/zsd-snapshots.png

18 KB
Loading

0 commit comments

Comments
 (0)