Merge branch 'master' of github.com:RichiH/vcsh

[code/vcsh.git] / README.md

diff --git a/README.md b/README.md
index fc7a8928bd8337d4e880f9fcaea69ab65ed2ee34..a83325d979ee4482a828111802d7882a4dbe141c 100644 (file)
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@ vcsh - Version Control System for $HOME - multiple Git repositories in $HOME
 2. [30 second howto](#30-second-howto)
 3. [Overview](#overview)
 4. [Getting Started](#getting-started)
 2. [30 second howto](#30-second-howto)
 3. [Overview](#overview)
 4. [Getting Started](#getting-started)

-5. [Usage](#usage)
+5. [Usage Exmaples](#usage-examples)

 6. [Contact](#contact)
 
 
 6. [Contact](#contact)
 
 


@@ -56,8 +56,9 @@ Let's say you want to version control your `vim` configuration:
     vcsh vim commit -m 'Initial commit of my Vim configuration'
     # optionally push your files to a remote
     vcsh vim remote add origin <remote>
     vcsh vim commit -m 'Initial commit of my Vim configuration'
     # optionally push your files to a remote
     vcsh vim remote add origin <remote>

-    vcsh vim push origin master:master
-    vcsh vim branch --track master origin/master
+    vcsh vim push -u origin master
+    # from now on you can push additional commits like this
+    vcsh vim push

 
 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
 a design feature.
 
 If all that looks a _lot_ like standard `git`, that's no coincidence; it's
 a design feature.


@@ -357,7 +358,41 @@ mr is used to actually retrieve configs, etc
     ~ % mr -j 5 up
 
 
     ~ % mr -j 5 up
 
 

-# Usage
+# Usage Examples
+
+All examples in this section will use the short form of `vcsh` which is the
+simplest way to interface with it. If you don't know what that means simply
+ignore this fact for now and follow the examples.
+
+## Initialize a new repository "vim"
+
+    vcsh init vim
+
+## Clone an existing repository
+
+    vcsh clone <remote> <repository_name>
+
+## Add files to repository "vim"
+
+    vcsh vim add ~/.vimrc ~/.vim
+    vcsh vim commit -m 'Update Vim configuration'
+
+## Add a remote for repository "vim"
+
+    vcsh vim remote add origin <remote>
+    vcsh vim push origin master:master
+    vcsh vim branch --track master origin/master
+
+## Push to remote of repository "vim"
+
+    vcsh vim push
+
+## Pull from remote of repository "vim"
+
+    vcsh vim pull
+
+
+# mr usage ; will be factored out & rewritten

 
 ### Keeping repositories Up-to-Date
 
 
 ### Keeping repositories Up-to-Date
 


@@ -388,7 +423,6 @@ repositories by running the necessary vcsh commands for you. You may choose not
 to use mr, in which case you will have to run those commands manually or by
 other means.
 
 to use mr, in which case you will have to run those commands manually or by
 other means.
 

-#### A Few Examples

 
 To initialize a new repository: `vcsh init zsh`
 
 
 To initialize a new repository: `vcsh init zsh`