Skip to content

Commit cdf1165

Browse files
committed
Update README
1 parent 06b2055 commit cdf1165

File tree

1 file changed

+12
-8
lines changed

1 file changed

+12
-8
lines changed

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,22 @@
11
# PairSync
22

3-
sync files automatically when saving by creating and applying git diffs over websockets
3+
Sync files automatically between two or more git repositories.
4+
One acts as the server and multiple clients can connect.
5+
If a file is modified on any machine the changes are broadcasted to the others.
46

5-
TODO
6-
7-
- [] initial syncing does not update untracked files and modified files
8-
- [] add support for the server to commit and all clients should fast forward with
9-
it
10-
- [] NPX support
11-
- [] track file deletion
7+
Enjoy pair programming!
128

139
DONE
1410

11+
- [X] NPM
12+
- [x] initial syncing does not update untracked files and modified files
1513
- [x] validate that every client is starting from the same hash, otherwise drop connection
1614
- [x] currently works only on localhost, use localtunnel
1715
- [x] use argv parsing library
1816
- [x] Untracked files are not handled
17+
18+
TODO
19+
20+
- [] track file deletion or validate that it is working
21+
- [] add commit support?
22+

0 commit comments

Comments
 (0)