outputdir + quickstart instructions

docs/index.rst

@@ -89,7 +89,7 @@ On the command-line:
     $ trafilatura -u "https://github.blog/2019-03-29-leader-spotlight-erin-spiceland/"
     # outputs main content and comments as plain text ...
 
-For more information please refer to the `usage documentation <usage.html>`_.
+For more information please refer to `quickstart <quickstart.html>`_, `usage documentation <usage.html>`_ and `tutorial <tutorial1.html>`_.
 
 
 License
@@ -160,6 +160,7 @@ Further documentation
    corefunctions
    evaluation
    installation
+   quickstart
    usage
    validation
    tutorial1

docs/quickstart.rst

@@ -0,0 +1,35 @@
+Quickstart
+==========
+
+
+With Python
+-----------
+
+.. code-block:: python
+
+    >>> import trafilatura
+    >>> downloaded = trafilatura.fetch_url('https://github.blog/2019-03-29-leader-spotlight-erin-spiceland/')
+    >>> trafilatura.extract(downloaded)
+    # outputs main content and comments as plain text ...
+    >>> trafilatura.extract(downloaded, xml_output=True, include_comments=False)
+    # outputs main content without comments as XML ...
+
+For arguments of the ``extract`` function see `core functions <corefunctions.html>`_.
+
+
+On the command-line
+-------------------
+
+.. code-block:: bash
+
+    $ trafilatura -u "https://github.blog/2019-03-29-leader-spotlight-erin-spiceland/"
+    # outputs main content and comments as plain text ...
+    $ trafilatura --xml --nocomments -u "URL..."
+    # outputs main content without comments as XML ...
+    $ trafilatura -h
+    usage: trafilatura [-h] [-f] [--formatting] [-i INPUTFILE] [-o OUTPUTDIR]
+                   [--nocomments] [--notables] [--csv] [--xml] [--xmltei]
+                   [--validate] [-u URL] [-v]
+
+
+For more information please refer to `usage documentation <usage.html>`_ and `tutorials <tutorial1.html>`_.

docs/usage.rst

@@ -86,14 +86,16 @@ The ``-i/--inputfile`` option allows for bulk download and processing of a list
 
 For all usage instructions see ``trafilatura -h``:
 
-``usage: trafilatura [-h] [-f] [--formatting] [-i INPUTFILE] [--nocomments] [--notables] [--xml] [--xmltei] [-u URL] [-v]``
+``usage: trafilatura [-h] [-f] [--formatting] [-i INPUTFILE] [-i OUTPUTDIR] [--nocomments] [--notables] [--xml] [--xmltei] [-u URL] [-v]``
 
 optional arguments:
   -h, --help         show this help message and exit
   -f, --fast         fast (without fallback detection)
   --formatting          include text formatting (bold, italic, etc.)
   -i INPUTFILE, --inputfile INPUTFILE
                      name of input file for batch processing
+  -o OUTPUTDIR, --outputdir OUTPUTDIR
+                     write results in a specified directory (relative path)
   --nocomments       don't output any comments
   --notables         don't output any table elements
   --csv              CSV output