Browse Source

Updating README

spesk1 5 years ago
parent
commit
af3be8cc7f
1 changed files with 33 additions and 2 deletions
  1. 33 2
      README.md

+ 33 - 2
README.md

@@ -3,10 +3,41 @@
 Project to abstract some of the weirder git operations or things that I forget. Should always be able to be used alongside git, as opposed to trying to replace it outright.
 Mainly writing to learn more about Git and Perl, unlikely to be widely useful.
 
-TODO:
+```
+simply-git
+Usage:
+        --view
+        Display git status of files and other information
+
+        --dump-config
+        Dump .git/config to STDOUT. Not really useful but exposed for testing of reading config into internal data structure
+
+        --push-all [--commit-msg]
+        Push all untracked and modified files 
+                * Can be used with interactive mode
+                * Can provide a commit msg with --commit-msg (otherwise a generic will be provided)
+
+        --interactive
+        Enable interactive mode with supported opts
+
+        --reset-from-master
+        Reset all current changes so that the file tree matches origin master
+
+        --reset-from-upstream [ --upstream-url ]
+        If upstream is defined will reset local branch to match upstream ( does not push changes to origin )
+                * Assumes you have an upstream configured
+                * Pass SSH/HTTPS URL to --upstream-url to add an upstream
+
+        --configure-local-user [--user,--email]
+        Configure local git user
+                * Can be used with interactive mode
+```
+
+# TODO:
 
 Features:
+
 No more ideas. Open to suggestions.
 
-Stuff to fix:
+## Stuff to fix:
 * multipule TODO:'s in various files