Merge pull request eclecticiq#60 from eclecticiq/fix-readme

Documentation improvements

README.rst

@@ -3,41 +3,36 @@ cabby
 
 Python TAXII client implementation from `EclecticIQ <https://www.eclecticiq.com>`_.
 
-:Source: https://github.com/EclecticIQ/cabby
+:Source: https://github.com/eclecticiq/cabby
 :Documentation: http://cabby.readthedocs.org
 :Information: https://www.eclecticiq.com
 :Download: https://pypi.python.org/pypi/cabby/
 
-|travis badge| |landscape.io badge| |coveralls.io badge| |docs badge| |requirements badge|
+|travis badge| |coveralls.io badge| |docs badge| |requirements badge|
 
-.. |travis badge| image:: https://travis-ci.org/EclecticIQ/cabby.svg?branch=master
-   :target: https://travis-ci.org/EclecticIQ/cabby
+.. |travis badge| image:: https://travis-ci.org/eclecticiq/cabby.svg?branch=master
+   :target: https://travis-ci.org/eclecticiq/cabby
    :alt: Build Status
-.. |landscape.io badge| image:: https://landscape.io/github/EclecticIQ/cabby/master/landscape.svg?style=flat
-   :target: https://landscape.io/github/EclecticIQ/cabby/master
-   :alt: Code Health
-.. |coveralls.io badge| image:: https://coveralls.io/repos/EclecticIQ/cabby/badge.svg
-   :target: https://coveralls.io/r/EclecticIQ/cabby
+.. |coveralls.io badge| image:: https://coveralls.io/repos/eclecticiq/cabby/badge.svg
+   :target: https://coveralls.io/r/eclecticiq/cabby
    :alt: Coverage Status
 .. |docs badge| image:: https://readthedocs.org/projects/cabby/badge/?version=latest
-    :alt: Documentation Status
-    :scale: 100%
-    :target: https://readthedocs.org/projects/cabby/
-.. |requirements badge| image:: https://requires.io/github/EclecticIQ/cabby/requirements.svg?branch=master
-     :target: https://requires.io/github/EclecticIQ/cabby/requirements/?branch=master
-     :alt: Requirements Status
+   :alt: Documentation Status
+   :scale: 100%
+   :target: https://readthedocs.org/projects/cabby/
+.. |requirements badge| image:: https://requires.io/github/eclecticiq/cabby/requirements.svg?branch=master
+   :target: https://requires.io/github/eclecticiq/cabby/requirements/?branch=master
+   :alt: Requirements Status
 
 A simple Python library for interacting with TAXII servers.
 
 
 Docker
 --------
 
-From version 0.1.13, the docker image is based on 'Alpine' linux. This means the size of the Image was reduced from 311MB to 74MB
-
 To run cabby using docker, execute the following:
 
-  docker run --rm=true eclecticiq/cabby:latest taxii-discovery --path https://test.taxiistand.com/read-only/services/discovery
+  docker run --rm eclecticiq/cabby taxii-discovery --path https://test.taxiistand.com/read-only/services/discovery
 
 Feedback
 --------

docker-help.sh

@@ -2,7 +2,7 @@
 
 _cmd=""
 if [ $0 = '/cabby/docker-help.sh' ]; then
-	_cmd="docker run -it eclecticiq/cabby "
+	_cmd="docker run --rm eclecticiq/cabby "
 fi
 
 cat <<EOF
@@ -20,6 +20,13 @@ EOF
 echo
 echo "For example: ${_cmd}taxii-discovery --path https://test.taxiistand.com/read-write/services/discovery"
 echo
+
+if [ $0 = '/cabby/docker-help.sh' ]; then
+	echo "You can also start an interactive shell with the commands above available:"
+	echo "  ${_cmd}bash"
+	echo
+fi
+
 echo "More information available at: http://cabby.readthedocs.org"
 echo
 

docs/user.rst

@@ -191,34 +191,9 @@ To ease the threshold for trying out Cabby, it is possible to use the image prov
 
 .. code-block:: shell
 
-    $ docker run cabby
-
-Running this will execute the help script, giving you all the possible options:
-
-.. code-block:: text
-
-    Commands to be run:
-
-        taxii-discovery
-        taxii-poll
-        taxii-collections
-        taxii-push
-        taxii-subscription
-        taxii-proxy
-
-    e.g. 
-    
-        $ docker run -ti cabby taxii-discovery \
-              --host test.taxiistand.com \
-              --use-https true \
-              --path /read-write/services/discovery
-
-    More information available at: http://cabby.readthedocs.org
-
-    Or you can choose to drop back into a shell by providing `bash` as the command:
-
-        $ docker run -ti cabby bash
+  $ docker run --rm cabby bash
 
+This will show you some helpful information on what commands are available, and then give you an interactive shell to play around in.
 
 .. rubric:: Next steps