Add nasdaq.py scraper and update README.

[insider.git] / README

diff --git a/README b/README
index 2e4ccbdca72863fdd355c4e60f5920a366bb7b6e..8063787b6e169b9d950928c0666541e3968cb98b 100644 (file)
--- a/README
+++ b/README
@@ -44,6 +44,21 @@ look like
 
   $ PYTHONPATH=".:$PYTHONPATH" python example/manage.py runserver
 
+Scraping
+========
+
+Entering transaction data by hand can be tedious and error prone.  To
+automate the task, you should write scrapers to look up and enter
+transaction data automatically.  To get you started, I've written
+`insider/scrape/nasdaq.py`, which scrapes `NASDAQ's interface`__ to
+`EDGAR`_\'s data.  Use the scraper with something like::
+
+  $ export PYTHONPATH='.'
+  $ export DJANGO_SETTINGS_MODULE='example.settings'
+  $ python insider/scrape/nasdaq.py NYSE:RHT NASDAQ:GOOG
+
+__ NASDAQ_
+
 Hacking
 =======
 
@@ -58,4 +73,6 @@ That's a good place to start if you're new to Django.
 .. _dt2-docs: http://django-tables2.readthedocs.org/en/latest/
 .. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
 .. _Django documentation: https://docs.djangoproject.com/
+.. _NASDAQ: http://www.nasdaq.com/reference/ownership.stm
+.. _EDGAR: http://www.edgar-online.com/
 .. _Django tutorial: https://docs.djangoproject.com/en/1.3/intro/tutorial01/