Skip to content

Commit

Permalink
Updated README. Version Bump to 0.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
firecat53 committed Dec 18, 2014
1 parent ed8f56d commit 9b159ef
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
14 changes: 12 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Requires: Python 2.6+ (including Python 3.x) and the python-urwid library
Features
--------

Urlscan parses an email message passed on standard input and scans it for URLs. It then displays the URLs and their context within the message, and allows you to choose one or more URLs to send to your Web browser.
Urlscan parses an email message or file and scans it for URLs and email addresses. It then displays the URLs and their context within the message, and allows you to choose one or more URLs to send to your Web browser. Alternatively, it send a list of all URLs to stdout.

Relative to urlview, urlscan has the following additional features:

Expand All @@ -31,7 +31,7 @@ Relative to urlview, urlscan has the following additional features:
Installation and setup
----------------------

To install urlscan, install from your distribution repositories, install the `Archlinux Package`_ , or install from source using setup.py.
To install urlscan, install from your distribution repositories, from Pypi, install the `Archlinux Package`_ , or install from source using setup.py.

.. NOTE::

Expand All @@ -49,6 +49,16 @@ To choose a particular browser, set the environment variable BROWSER:

export BROWSER=/usr/bin/epiphany


Command Line usage
------------------

::

urlscan [-n] <file>

Urlscan can extract URLs and email addresses from emails, or any text file. Calling without the '-n' flag will start the curses browser. Calling with '-n' will just output a list of URLs/email addressess to stdout. Files can also be piped to urlscan using normal shell pipe mechanisms: `cat <something> | urlscan` or `urlscan < <something>`

Known bugs and limitations
--------------------------

Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
from distutils.core import setup

setup(name="urlscan",
version="0.7.2",
description="View the URLs in an email message",
version="0.8.0",
description="View/select the URLs in an email message or file",
author="Scott Hansen",
author_email="firecat4153@gmail.com",
packages=['urlscan'],
Expand Down

0 comments on commit 9b159ef

Please sign in to comment.