aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorGravatar Jon Bernard <jbernard@tuxion.com> 2013-11-07 09:39:42 -0500
committerGravatar Jon Bernard <jbernard@tuxion.com> 2013-11-07 09:39:42 -0500
commit2b3ff6e5f524b5aea0a31689e08e204e4fae0b36 (patch)
tree6c853a735574f8b47d8119c8680f8cc3467bc0b5 /README.rst
parentc97f331ea2ebe7ae46ea04f81cfc01eba7ef7a75 (diff)
parente04b5e6cb601bce8c5e3db1b6dd998158d7d4b42 (diff)
downloaddotfiles-2b3ff6e5f524b5aea0a31689e08e204e4fae0b36.tar.gz
dotfiles-2b3ff6e5f524b5aea0a31689e08e204e4fae0b36.tar.bz2
dotfiles-2b3ff6e5f524b5aea0a31689e08e204e4fae0b36.zip
Merge branch 'feature/single-sync'
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.rst b/README.rst
index dca0e9b..640d174 100644
--- a/README.rst
+++ b/README.rst
@@ -1,11 +1,17 @@
Dotfile management made easy
============================
+.. image:: https://pypip.in/v/dotfiles/badge.png
+ :target: https://pypi.python.org/pypi/dotfiles
+
+.. image:: https://secure.travis-ci.org/jbernard/dotfiles.png?branch=develop
+ :target: http://travis-ci.org/jbernard/dotfiles
+
``dotfiles`` is a tool to make managing your dotfile symlinks in ``$HOME``
easy, allowing you to keep all your dotfiles in a single directory.
-Hosting is up to you. Using whatever VCS you prefer, or even rsync, you can
-easily distribute your dotfiles repository across multiple hosts.
+Hosting is up to you. You can use a VCS like git, Dropbox, or even rsync to
+distribute your dotfiles repository across multiple hosts.
The repository can be specified at runtime, so you can manage multiple
repositories without hassle. See the Configuration_ section below for further
@@ -29,12 +35,14 @@ Interface
``-r, --remove <file...>``
Remove dotfile(s) from the repository.
-``-s, --sync``
+``-s, --sync [file...]``
Update dotfile symlinks. You can overwrite colliding files with ``-f`` or
- ``--force``.
+ ``--force``. All dotfiles are assumed if you do not specify any files to
+ this command.
-``-m, --move``
- Move dotfiles repository to another location.
+``-m, --move <path>``
+ Move dotfiles repository to another location, updating all symlinks in the
+ process.
For all commands you can use the ``--dry-run`` option, which will print actions
and won't modify anything on your drive.