aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKosta Harlan <kostajh@gmail.com>2013-09-02 16:30:44 -0400
committerKosta Harlan <kostajh@gmail.com>2013-09-02 16:30:44 -0400
commit9b7388a4a748067a2fe631ed15eff1ed8dfdf385 (patch)
treed48ff2a81f7900b59f531ff04b05db63a3f313c0 /README.md
parent2bbdf4f80969aced6fc5f732cce1fdb0108be7b0 (diff)
downloadtask-git-9b7388a4a748067a2fe631ed15eff1ed8dfdf385.tar.xz
task-git-9b7388a4a748067a2fe631ed15eff1ed8dfdf385.zip
Use existing data dir as repo, update README, and option to push to remote. Fixes #1 and #2
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 6 insertions, 4 deletions
diff --git a/README.md b/README.md
index 1760e87..2f8921e 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,13 @@ is altered.
## Usage
-Add `alias task=/path/to/task-git/task-git.sh` to your `.bashrc` or
-`.profile`, and run `chmod +x /path/to/task-git/task-git.sh`.
+1. Navigate to your Taskwarrior data directory (usually in `~/.task`) and type `git init`. If you plan to push to a remote, go ahead and add your remote now.
+2. Add `alias task=/path/to/task-git/task-git.sh` to your `.bashrc` or
+`.profile`. If you want to push to a remote, then the alias should be `alias task=/path/to/task-git/task-git.sh --task-git-push`. Make sure you source the `.bashrc` or `.profile`.
+3. Run `chmod +x /path/to/task-git/task-git.sh`.
+4. Use `task` as normal; when run, the Taskwarrior database files will be committed to version control.
-Backups are generated alongside the existing `.task` database in a new directory
-called `.task.bak`.
+It is recommended to use the Taskwarrior database only on one machine, as you will be resolving conflicts if using one multiple machines.
## License