svn commit: r1684060 - in /comdev/tools: events_list/readme.md readme.md

[rg...@apache.org]

Author: rgardler
Date: Sun Jun  7 18:42:17 2015
New Revision: 1684060

URL: http://svn.apache.org/r1684060
Log:
move events_list notes into root readme

Modified:
    comdev/tools/events_list/readme.md
    comdev/tools/readme.md

Modified: comdev/tools/events_list/readme.md
URL: http://svn.apache.org/viewvc/comdev/tools/events_list/readme.md?rev=1684060&r1=1684059&r2=1684060&view=diff
==============================================================================
--- comdev/tools/events_list/readme.md (original)
+++ comdev/tools/events_list/readme.md Sun Jun  7 18:42:17 2015
@@ -3,7 +3,7 @@ managing a list of events related to the
 
 # Features #
 
-  * Run as a script (get_meetups) or as an interactive menu
+  * Run as a script (python get_meetups) or as an interactive menu (python menu)
   * Import events from meetups.com that might be Apache related
   * Generate a mail template for events in the next 7 days
   * Generate a Markdown file for hosting on a website or similar

Modified: comdev/tools/readme.md
URL: http://svn.apache.org/viewvc/comdev/tools/readme.md?rev=1684060&r1=1684059&r2=1684060&view=diff
==============================================================================
--- comdev/tools/readme.md (original)
+++ comdev/tools/readme.md Sun Jun  7 18:42:17 2015
@@ -3,7 +3,49 @@ development.
 
 # Features #
 
-  * Build and manage lists of events of community interest
+Currently we have a Command Line Interface and a Web Interface. At the
+time of writing the CLI is more feature complete. Furthermore, at the
+time of writing the two systems do not share the same database, in
+fact the CLI does not persist its data between executions (it is
+written to a JSON file but this is overwritten on each run).
+
+## Command Line Features ##
+
+  * Run as a script (python get_meetups) or as an interactive menu (python menu)
+  * Import events from meetups.com that might be Apache related
+  * Generate a mail template for events in the next 7 days
+  * Generate a Markdown file for hosting on a website or similar
+  * Generate a file containing suggested tweets
+
+Run as either a Python application or as a Docker containerized
+application.
+
+## Web Application Features##
+
+  * Import new meetups from meetups.com
+  * Maintain data in a database
+  
+# Python CLI Script #
+
+To run the application as a Python script simply execyte get_meetups
+or memu in the root of the project.
+This will create a number of files in the project directory:
+
+  * meetups.mlist - a template email for events in the next week
+  * meetups.mdtext - a markdown file of events i nthe next 2 weeks
+  * meetups.tweets - suggested tweets for events in the next 2 weeks
+  * meetups.json - a json file of all meetups
+  * groups.json - a json file containing all groups organizin meetings
+
+Alternatively you can run the "menu" script which will present a
+command line menu allowing you to work with the events list.
+
+Note that these are POSSIBLY Apache-related. Typically, there's around
+a 50% false positive rate, what with hiking trails, native American
+dance enthusiasts, and heilcopter fans. These lists MUST be manually
+filtered before they are used anywhere publicly.
+
+If you use this script be respectful of the included API key.
 
 # Development #