mostly working now. need to unhardcode username and breakup limit

[oss/ljdump.git] / README.txt

diff --git a/README.txt b/README.txt
index d9deccb07604a132da1b71b950f2ae3e12ba04e2..5858b9b3d2204500c0f05bb0a81a01a0bdc30ae8 100644 (file)
--- a/README.txt
+++ b/README.txt
@@ -3,6 +3,19 @@ ljdump - livejournal archiver
 This program reads the journal entries from a livejournal (or compatible)
 blog site and archives them in a subdirectory named after the journal name.
 
+The simplest way to run this is to execute the ljdump.py script with Python.
+Depending on your OS, you may be able to double-click the ljdump.py script
+directly, or you may need to open a Terminal/Command Prompt window to run it.
+Either way, it will prompt you for your Livejournal username and password,
+then download all your journal entries, comments, and userpics.
+
+You may optionally download entries from a different journal (a community)
+where you are a member. If you are a community maintainer, you can also
+download comments from the community.
+
+If you want to save your username and password so you don't have to type
+it every time you run ljdump, you can save it in the configuration file.
+
 The configuration is read from "ljdump.config". A sample configuration is
 provided in "ljdump.config.sample", which should be copied and then edited.
 The configuration settings are:
@@ -17,6 +30,12 @@ The configuration settings are:
   password - The account password. This password is never sent in the
              clear; the livejournal "challenge" password mechanism is used.
 
+  journal - Optional: The journal to download entries from. If this is
+            not specified, the "username" journal is downloaded. If this
+            is specified, then only the named journals will be downloaded
+            (this element may be specified more than once to download
+            multiple journals).
+
 This program may be run as often as needed to bring the backup copy up
 to date. Both new and updated items are downloaded.