new readme

Author: antonizoon

README.rst

@@ -1,7 +1,11 @@
-BASC Thread Archiver
-====================
+BASC Archiver
+=============
 
-This script uses the `4chan API <https://github.com/4chan/4chan-API>`_ to:
+The **BASC Archiver** is a Python library used to archive imageboard threads. It uses the `4chan API <https://github.com/4chan/4chan-API>`_ with the py4chan wrapper. Developers are free to use the BASC-Archiver library for some interesting third-party applications, as it is licensed under the LGPLv3.
+
+It comes with a CLI interface for archiving threads, the **thread-archiver**. (A GUI interface, the BASC-Archiver, is under development.)
+
+The **thread-archiver** is designed to archive all content from a 4chan thread:
 
 * Download all images and/or thumbnails in given threads.
 * Download a JSON dump of thread comments using the 4chan API.
@@ -11,11 +15,28 @@ This script uses the `4chan API <https://github.com/4chan/4chan-API>`_ to:
 * Keep downloading until 404 (with a user-set delay)
 * Can be restarted at any time
 
-This script is designed to replace the typical "Right-click Save As, Web Page Complete" action, since that does not save full-sized images or JSON. 
+The **thread-archiver** replaces the typical "Right-click Save As, Web Page Complete" action, which does not save full-sized images or JSON. It works as a guerilla, static HTML alternative to Fuuka.
 
-This can also be used as a guerilla, static HTML alternative to Fuuka.
+Usage
+=====
 
-Part of the JSON-based-chanarchiver by Antonizoon Overtwater, built 2013/04/04.
+::
+  Usage:
+    thread-archiver <url>... [--path=<string>] [--runonce] [--silent] [--verbose] [--delay=<int>] [--nothumbs] [--thumbsonly] [--ssl]
+    thread-archiver -h | --help
+    thread-archiver -v | --version
+
+  Options:
+    --path=<string>     Path to folder where archives will be saved [default: ./archive]
+    --runonce           Downloads the thread as it is presently, then exits
+    --delay=<int>       Delay between thread checks [default: 20]
+    --nothumbs          Don't download thumbnails
+    --thumbsonly        Download thumbnails, no images
+    --ssl               Download using HTTPS
+    --silent            Suppresses mundane printouts, prints what's important
+    --verbose           Printout more information than normal
+    -h --help           Show help
+    -v --version        Show version
 
 Example
 =======
@@ -27,11 +48,11 @@ Example
 Installation
 ============
 
+The BASC-Archiver works on both Python 2.x and 3.x, and can be installed on Windows, Linux, or Mac OS X.
+
 Windows
 -------
 
-> **Note:** This script is now fixed for Windows and Python 3.x. PyQt GUI coming soon.
-
 1. Install `ActivePython <http://www.activestate.com/activepython/downloads>`_,  Either version 2.x and 3.x will work. Make sure to enable the PyPM option, or else `pip will not be installed! <http://stackoverflow.com/questions/4750806/how-to-install-pip-on-windows/4750846#4750846>`_
 2. After installation, go to the Start Menu and under the **ActiveState ActivePython** programs folder, click **Python Package Manager (PyPM)**.
 3. A command prompt will appear. Type in the command below and press enter:
@@ -52,7 +73,7 @@ Windows
 
         python thread-archiver http://boards.4chan.org/b/res/423861837 --path="C:\Users\Danny\4chan-threads"
   
-6. Sometimes, 4chan will make changes to it's API. We aim to update the script as soon as any change occurs, so if something's not working right, first use the command below to update. If you're still having problems, raise an issue on our `Github. <https://github.com/bibanon/BA-4chan-thread-archiver>`_
+6. Sometimes, 4chan will make changes to it's API. We aim to update the script as soon as any change occurs, so if something's not working right, use the command below to upgrade to the latest version. If you're still having problems, raise an issue on our `Github. <https://github.com/bibanon/BA-4chan-thread-archiver>`_
 
 ::
 
@@ -75,7 +96,7 @@ Linux/Mac
 
     thread-archiver http://boards.4chan.org/b/res/423861837
 
-4. Sometimes, 4chan will make changes to it's API. We aim to update the script as soon as any change occurs, so if something's not working right, first use the command below to update. If you're still having problems, raise an issue on our `Github. <https://github.com/bibanon/BA-4chan-thread-archiver>`_
+4. Sometimes, 4chan will make changes to it's API. We aim to update the script as soon as any change occurs, so if something's not working right, use the command below to upgrade to the latest version. If you're still having problems, raise an issue on our `Github. <https://github.com/bibanon/BA-4chan-thread-archiver>`_
 
 ::
 
@@ -84,41 +105,31 @@ Linux/Mac
 Where to Post Archived threads
 ===============================
 
-After archiving your threads, you can just upload the entire `4chan` to any static HTML host (no PHP needed). We strongly recommend that you share them with the world on some kind of Static HTML host, such as the following:
+Your archived threads can be viewed from any web browser. Just enter the thread's folder, and open the HTML file.
+
+Alternatively, you can upload the entire **archive** folder to any static HTML host, no PHP required. We strongly recommend that you share them with the world on some kind of Static HTML host, such as the following:
 
 * Github Pages
 * Gitorious Pages
 * Google Pages
+* 000webhost
 * And more!
 
 Please make sure that your content follows the chosen host's Terms of Service policies (keep your pr0n to yourself, etc.).
 
-In the future we will make an extension that records links to currently downloaded threads in an index.html file...
-
-Modifications to original
-==========================
-
-Originally forked from Socketub's `4chan-thread-archiver. <https://github.com/socketubs/4chan-thread-archiver>`_ 
-
-However, all the original has long since been replaced, and the scripts are totally different. Here is a list of additions:
-
-* Based on `py4chan <https://github.com/e000/py-4chan>`_
-* Downloads HTML dump of thread
-* New --thumbsonly option to download thumbnails and no images
-* Code modularization
-* More comments in code
-* Support for new 4cdn.org server
+Wishlist
+========
 
-More info and a full journal can be found in ``documents/log.md``.
+* **Migrate to BA-py4chan**, the improved fork of Edgeworth's original py-4chan wrapper.
+* **.chan.arc** - Standard archival format definition for imageboards.
+* Create a **pyFuuka**, for archiving from Fuuka's API.
+* **index.html list** - In the future we will make an extension that records links to currently downloaded threads in an index.html file...
 
 License
 =======
 
-The 4chan Archiver Class is based on Bibliotheca Anonoma `BA-4chan-thread-archive <https://github.com/bibanon/BA-4chan-thread-archiver>`_ tool, and was originally forked from Socketub's `4chan-thread-archiver. <https://github.com/socketubs/4chan-thread-archiver>`_ The original license of Socketub's archiver is the GNU Affero General Public License v3 or later.
+The 4chan Archiver Class is jointly written and maintained by by `antonizoon.`_ <https://github.com/antonizoon> and `Daniel Oaks.`_ <https://github.com/DanielOaks>. 
 
-Wishlist
-=========
+It is based on, and supersedes the Bibliotheca Anonoma's `BA-4chan-thread-archiver <https://github.com/bibanon/BA-4chan-thread-archiver>`_ tool, written by `antonizoon.`_ <https://github.com/antonizoon>.
 
-* Prompt user for metadata information.
-* Define the ``.chan.zip`` format for 4chan thread archive transfer
-* Create a PyQt GUI
+The BA-4chan-thread-archiver was originally forked from Socketub's `4chan-thread-archiver. <https://github.com/socketubs/4chan-thread-archiver>`_, originally licensed under the GNU Affero General Public License v3 or later.