From e3074dc8ea384275fb1cd1430b38ceb3e50ba0fc Mon Sep 17 00:00:00 2001 From: Jon Bernard Date: Thu, 13 Oct 2016 13:16:26 -0400 Subject: Rework the readme a bit, still much to do --- README.rst | 42 ++++++++++++++++++++++-------------------- 1 file changed, 22 insertions(+), 20 deletions(-) (limited to 'README.rst') diff --git a/README.rst b/README.rst index 192fd09..0f6d17a 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,25 @@ -*Update:* I've managed to find some free time recently and have been making -some changes and improvements that hopefully people will appreciate. At the -moment the ``master`` branch is in a state of flux until I get all of the -pieces included. +Dotfile management made easy +============================ + +``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. 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 +details. + +Directories are supported as well. Any file object in your home directory that +starts with a ``.`` is fair game. + +Recent Changes +-------------- + +I've managed to find some free time recently and have been making some changes +and improvements that hopefully people will appreciate. At the moment the +``master`` branch is in a state of flux until I get all of the pieces included. Feel free to use the latest stable version ``0.6.4`` on pypi if that's what you're looking for. @@ -20,22 +38,6 @@ released soon. There are some changes in interface and behaviour from the previous version and I hope it doesn't frustrate folks too much. Feel free to submit an issue if you find something intolerable. -Dotfile management made easy -============================ - -``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. 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 -details. - -Directories are supported as well. Any file object in your home directory that -starts with a ``.`` is fair game. - Interface --------- -- cgit v1.2.3