summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoey Hess <joeyh@joeyh.name>2015-01-23 18:09:50 -0400
committerJoey Hess <joeyh@joeyh.name>2015-01-23 18:09:50 -0400
commit849f3743ff1541aaec93013859cb6ed285496c8d (patch)
tree179257ccc03cabaf8984bb7b26d60debc4c6b5f4 /doc
parent2e12f9a496da113ea7cd13c7a3382ac732db4e44 (diff)
update docs
Diffstat (limited to 'doc')
-rw-r--r--doc/README.mdwn2
-rw-r--r--doc/index.mdwn16
-rw-r--r--doc/install.mdwn4
3 files changed, 17 insertions, 5 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn
index 33ff4a7..4528eb3 100644
--- a/doc/README.mdwn
+++ b/doc/README.mdwn
@@ -284,4 +284,4 @@ etckeeper is licensed under version 2 or greater of the GNU GPL.
## author
-Joey Hess <joey@kitenet.net>
+Joey Hess <id@joeyh.name>
diff --git a/doc/index.mdwn b/doc/index.mdwn
index 54ad97e..7f76bb2 100644
--- a/doc/index.mdwn
+++ b/doc/index.mdwn
@@ -1,10 +1,22 @@
+etckeeper is a collection of tools to let `/etc` be stored in a git,
+mercurial, bazaar or darcs repository. This lets you use git to review or
+revert changes that were made to `/etc`. Or even push the repository
+elsewhere for backups or cherry-picking configuration changes.
+
+It hooks into package managers like apt to automatically commit changes
+made to /etc during package upgrades. It tracks file metadata that git does
+not normally support, but that is important for /etc, such as the
+permissions of `/etc/shadow`.
+
+It's quite modular and configurable, while also being simple to use if you
+understand the basics of working with version control.
+
<html>
<video controls width=400 title="introduction to etckeeper by Francois Marier" src="https://downloads.kitenet.net/videos/etckeeper.ogv"></video>
</html>
-[[!inline raw=yes pages="README"]]
-
[[!sidebar content="""
+[[README]]
[[install]]
[[news]]
[[todo]]
diff --git a/doc/install.mdwn b/doc/install.mdwn
index 2997373..346082c 100644
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,5 +1,5 @@
-etckeeper is available in git at `git://git.kitenet.net/etckeeper`, or
-[in gitweb](http://git.kitenet.net/?p=etckeeper.git).
+etckeeper is available in git at `git://git.joeyh.name/etckeeper`, or
+[in gitweb](http://git.joeyh.name/?p=etckeeper.git).
It's packaged in Debian, Ubuntu, Fedora, etc.