Commits

Christophe-Marie Duquesne committed 71cd172

Explained where the token is stored

Comments (0)

Files changed (1)

 Usage
 =====
 
+Configuration
+-------------
+
+At the first run, you will be prompted an url. Click it, authorize michel.
+You're done!
+
+The authorization token is stored in $XDG_DATA_HOME/michel/oauth.dat. This
+is the only information stored.
+
 Commands
 --------
 
 Michel keeps it stupid simple. It only has two commands:
 
     michel pull
-which prints the default todo list on the standard output
+Print the default todo list on the standard output
 
     michel push <TODO.txt>
-which replaces the default todo list with the content of TODO.txt
+Replace the default todo list with the content of TODO.txt
 
 Non features
 ------------
 One line is one task. tab-indented lines (with the real tab character)
 are subtasks of the "parent" line.
 
-Suggestion
-----------
+How to
+------
 
 Here is how michel can be used. A crontask pulls every 15 minutes the
 default TODO list, and another one displays a notification during 10
 
 install python-xdg, then run
 
-    easy_install michel
-
-or
-
     pip install michel
 
 About
 Contributing
 ------------
 
-As usual, patches are welcome.
+Patches are welcome, as long as they keep the source simple and short.
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.