# HG changeset patch
# User k0s <k0scist@gmail.com>
# Date 1267596437 18000
# Node ID 7328744920deb3cdd5c649df16e06296666fb633
# Parent  01015b36290a2feebe83e820dbd1ad4fbaa4fc4f
adding README file

diff -r 01015b36290a -r 7328744920de README.txt
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.txt	Wed Mar 03 01:07:17 2010 -0500
@@ -0,0 +1,66 @@
+smartopen
+=========
+
+smartopen is a command line program that will transform text according
+to handlers to URLs and open them 
+
+Usage
+-----
+
+``smartopen --help`` displays the program usage:
+
+"""
+Usage: smartopen [options]
+
+Options:
+  -h, --help            show this help message and exit
+  -c CONFIG, --config=CONFIG
+                        config file to read
+  -u, --url             print the first url handled
+  -a, --all             print all handlers that match the query
+  -H HANDLERS, --handler=HANDLERS
+                        name of the handler to use, in order
+  --print-handlers      print all handlers in order they would be tried
+"""
+
+smartopen reads text from standard input or command line arguments.
+The handlers are then iterated through in a configurable order and, if
+the handler can transform the text into a URL, the URL is then
+processed.  Unless otherwise specified by command line options
+(e.g. --url, --all), the first matching URL is then opened in firefox.
+
+
+Handlers
+--------
+
+smartopen has a pluggable system of configurable handlers.  The
+setuptools entry point ``[smartopen.locations]`` is an extension point
+for the handlers.  Several handlers come with smartopen, or you can
+write your own.
+
+URL:  a resolvable URL
+Google: a google search
+Wikipedia: a Wikipedia article
+GoogleMaps: an address in google maps
+
+
+Configuration
+-------------
+
+smartopen uses a configuration file that defines the order of the
+handlers and their behavior.
+
+
+Interfacing With Your Environment
+---------------------------------
+
+While smartopen is useful of its own right, its utility may be
+enhanced by using as part of an environment.  For instance, I run the
+fluxbox window manager which allows the use of hotkeys.  By binding
+smartopen to Ctrl+Alt+s and using xclip, I can open a URL that is
+mappable to a smartopen handler with a keyboard shortcut.  The
+relevant line from my ~/.fluxbox/keys file reads:
+
+Control Mod1 s :ExecCommand /home/jhammel/python/smartopen.py "$(xclip -o)" # smartopen
+
+
diff -r 01015b36290a -r 7328744920de setup.py
--- a/setup.py	Sat Nov 21 19:52:10 2009 -0500
+++ b/setup.py	Wed Mar 03 01:07:17 2010 -0500
@@ -1,13 +1,17 @@
 from setuptools import setup, find_packages
 import sys, os
 
+try:
+    description = file('README.txt').read()
+except:
+    description = ''
+
 version = '0.1.1'
 
 setup(name='smartopen',
       version=version,
       description="open text in a browser contextually",
-      long_description="""\
-""",
+      long_description=description,
       classifiers=[], # Get strings from http://pypi.python.org/pypi?%3Aaction=list_classifiers
       keywords='',
       author='Jeff Hammel',
diff -r 01015b36290a -r 7328744920de smartopen.ini
--- a/smartopen.ini	Sat Nov 21 19:52:10 2009 -0500
+++ b/smartopen.ini	Wed Mar 03 01:07:17 2010 -0500
@@ -1,5 +1,3 @@
 [DEFAULTS]
-handlers = GoogleMaps, Trac, Wikipedia, Google
+handlers = URL, GoogleMaps, Trac, Wikipedia, Google
 
-[Trac]
-baseurl = http://trac.openplans.org/opencore
\ No newline at end of file