branch: scratch/gited
commit 4ef8628f62c518afea0526a8eafdce29b7986270
Author: Tino Calancha <[email protected]>
Commit: Tino Calancha <[email protected]>
Update documentation
* gited.el: Add Bugs/TODO section and URL header. Update comentary section.
* README.md: Add simple example.
---
packages/gited/README.md | 44 ++++++++++++++++++++++++++++++++++++++++++++
packages/gited/gited.el | 4 ++--
2 files changed, 46 insertions(+), 2 deletions(-)
diff --git a/packages/gited/README.md b/packages/gited/README.md
index 5a72246..8909f6c 100644
--- a/packages/gited/README.md
+++ b/packages/gited/README.md
@@ -22,3 +22,47 @@ Gited; that's because most of the Gited commands with a
Dired equivalent
share same keybindings.
For instance *gited-rename-branch* is bound to 'R' as *dired-do-rename*.
Similarly, *gited-mark* is bound to 'm' as *dired-mark*.
+
+## How to push to the remote repo. your local changes
+
+Suppose you want to update a file *foo* (*).
+
+From the Gited buffer:
+
+```
+c master RET ; Checkout master branch (**).
+*< ; Synchronize with remote repository.
+```
+
+Now, update *foo* with your changes and save it.
+
+From the Gited buffer:
+
+```
+A ; Stage your changes.
+```
+
+```
+C-c c "Updated foo" RET ; Commit them.
+```
+
+```
+*> ; Public your changes into the remote repository.
+```
+
+---
+(*) We have restricted to 1 file for simplicity. The recipe works
+ for N>=1 files.
+
+(**) For changes that require several commits you might prefer to
+ work in a separated branch 'feature'. In that case you'd
+ merge the master branch with 'feature' before ```*>```).
+
+
+### Bugs/TODO
+
+* Currently, *origin* is assumed as the remote repository:
+ Remove some hardcode *origin* around, and extend it
+ to handle multiple remotes.
+
+* Pull requests are not implemented.
diff --git a/packages/gited/gited.el b/packages/gited/gited.el
index 85540c4..0c1e927 100644
--- a/packages/gited/gited.el
+++ b/packages/gited/gited.el
@@ -10,9 +10,9 @@
;; Compatibility: GNU Emacs: 24.4
;; Version: 0.2.0
;; Package-Requires: ((emacs "24.4") (cl-lib "0.5"))
-;; Last-Updated: Thu Jun 08 22:31:32 JST 2017
+;; Last-Updated: Fri Jun 09 20:41:14 JST 2017
;; By: calancha
-;; Update #: 652
+;; Update #: 653
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
