edgimar avatar edgimar committed cceae07

- updated documentation with info on profiles, usage-examples, etc.
- fixed typo with --profile argument help-string

Comments (0)

Files changed (2)

+Description
+===========
+
 Michel-orgmode is a fork of [michel](https://github.com/chmduquesne/michel)
 which serves as a bridge between an [org-mode](http://orgmode.org/) textfile
 and a google-tasks task list.  It can push/pull org-mode text files to/from
 Usage
 =====
 
+Examples
+--------
+
+- Pull your default task-list to an org-mode file:
+
+            michel --pull --orgfile myfile.org
+
+- Pull the default task-list from a different google account to an org-mode file:
+
+            michel --pull --orgfile myfile_other.org --profile other_acct
+
+- Push an org-mode file to your default task-list:
+
+            michel --push --orgfile myfile.org
+
+- Synchronize an org-mode file with your default task-list:
+
+            michel --sync --orgfile myfile.org
+
+- Synchronize an org-mode file with your task-list named "Shopping":
+
+            michel --sync --orgfile shopping.org --listname Shopping
+
 Configuration
 -------------
 
-At the first run, you will be shown a URL. Click it, and authorize michel.
-You're done!
+The first time michel is run under a particular profile, you will be shown a
+URL.  Click it, and authorize michel to access google-tasks data for whichever
+google-account you want to associate with the profile.  You're done!  If no
+profile is specified when running michel, a default profile will be used.
 
-The authorization token is stored in `$XDG_DATA_HOME/michel/oauth.dat`. This
-is the only information stored.
+The authorization token is stored in
+`$XDG_DATA_HOME/michel/<profile-name>_oauth.dat`. No other information is
+stored, since the authorization token is the only information needed for michel
+to authenticate with google and access your tasks data.
+
 
 Command line options
 --------------------
 
     usage: michel [-h] (--push | --pull | --sync) [--orgfile FILE]
-                  [--listname LISTNAME]
+                  [--profile PROFILE] [--listname LISTNAME]
 
     optional arguments:
       -h, --help           show this help message and exit
       --pull               replace FILE with the contents of LISTNAME.
       --sync               synchronize changes between FILE and LISTNAME.
       --orgfile FILE       An org-mode file to push from / pull to
+      --profile PROFILE    A user-defined profile name to distinguish between
+                           different google accounts
       --listname LISTNAME  A GTasks list to pull from / push to (default list if
                            empty)
 
 ---------------
 
 This script currently only supports a subset of the org-mode format.  The
-following elements are mapped mapped between google-tasks and an org-mode file:
+following elements are mapped mapped between a google-tasks list and an
+org-mode file:
 
-* Indented Tasks <-> Number of preceding asterisks
-* Task Notes <-> Headline's body text
-* Checked-off / crossed-out <-> Headline is marked as DONE
+* Task Indentation <--> Number of asterisks preceding a headline
+* Task Notes <--> Headline's body text
+* Checked-off / crossed-out <--> Headline is marked as DONE
 
 
 Installation Dependencies
     # gtasks://profile/listname, and having only --from and --to flags)
     parser.add_argument('--profile',
             required=False,
-            help='A user-defined name profile name to distinguish between '
+            help='A user-defined profile name to distinguish between '
                  'different google accounts')
     parser.add_argument('--listname',
             help='A GTasks list to pull from / push to (default list if empty)')
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.