Update README with new `apply` interface.

Also clean up stale TODO.
pull/3/head
Joshua Potter 2022-01-09 10:13:46 -05:00
parent c80eeb5a8c
commit 37394588e5
2 changed files with 6 additions and 10 deletions

View File

@ -1,6 +1,6 @@
# homesync
**Caution! This is a work in progress and far from complete!**
**Caution! This is a work in progress!**
## Introduction
@ -109,18 +109,15 @@ $ homesync push
```
If looking to copy a configuration tracked by homesync to your desktop, you
can run
can run either:
```bash
$ homesync apply <filename>
$ homesync apply <PACKAGE>
$ homesync apply --all
```
To copy all configurations (and optionally overwrite files that already exist),
you can run
```bash
$ homesync apply --all [--overwrite]
```
The latter command overwrites all configuration files in favor of those found in
the local repository.
## Known Issues

View File

@ -11,7 +11,6 @@ use std::{
};
// TODO(jrpotter): Add pid file to only allow one daemon at a time.
// TODO(jrpotter): Sync files to local git repository.
// ========================================
// Polling