Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Updated README.md with proper description of project.

  • Loading branch information...
commit 284c018df998ebc4a35236169344a68ffca6aab9 1 parent 6ed494b
Aaron Kromer authored April 30, 2012

Showing 1 changed file with 62 additions and 2 deletions. Show diff stats Hide diff stats

  1. 64  README.md
64  README.md
Source Rendered
... ...
@@ -1,7 +1,67 @@
1  
-JSTwitter
  1
+Event Reporter
2 2
 =========
3 3
 This is my work through of the [Jumpstart Labs](http://jumpstartlab.com/)
4  
-Ruby exericse [JSTwitter](https://github.com/JumpstartLab/curriculum/blob/master/source/projects/event_reporter.markdown).
  4
+Ruby exericse [Event Reporter](https://github.com/JumpstartLab/curriculum/blob/master/source/projects/event_reporter.markdown).
5 5
 
6 6
 The approach I am taking for this is to try some BDD using [Cucumber](http://cukes.info/)
7 7
 and [RSpec](http://rspec.info/).
  8
+
  9
+
  10
+#### Command Prompt Instructions
  11
+
  12
+##### `load <filename>`
  13
+
  14
+Erase any loaded data and parse the specified file. If no filename is given, default to `event_attendees.csv`.
  15
+
  16
+##### `help`
  17
+
  18
+Output a listing of the available individual commands
  19
+ 
  20
+##### `help <command>`
  21
+
  22
+Output a description of how to use the specific command. For example:
  23
+
  24
+```
  25
+help queue clear
  26
+help find
  27
+```
  28
+
  29
+##### `queue count`
  30
+
  31
+Output how many records are in the current queue
  32
+
  33
+##### `queue clear`
  34
+
  35
+Empty the queue
  36
+
  37
+##### `queue print`
  38
+
  39
+Print out a tab-delimited data table with a header row following this format:
  40
+
  41
+```
  42
+  LAST NAME  FIRST NAME  EMAIL  ZIPCODE  CITY  STATE  ADDRESS  PHONE
  43
+```
  44
+
  45
+##### `queue print by <attribute>`
  46
+
  47
+Print the data table sorted by the specified `attribute` like `zipcode`.
  48
+
  49
+##### `queue save to <filename.csv>`
  50
+
  51
+Export the current queue to the specified filename as a CSV. The file should should include data and headers for last name, first name, email, zipcode, city, state, address, and phone number.
  52
+
  53
+##### `find <attribute> <criteria>`
  54
+
  55
+Load the queue with all records matching the criteria for the given attribute. Example usages:
  56
+
  57
+* `find zipcode 20011`
  58
+* `find last_name Johnson`
  59
+* `find state VA`
  60
+
  61
+The comparison should:
  62
+
  63
+* Be insensitive to case, so `"Mary"` and `"mary"` would be found in the same search
  64
+* Be insensitive to internal whitespace, but not external:
  65
+  * `"John"` and `"John "` are considered matches
  66
+  * `"John Paul"` and `"Johnpaul"` are not matches
  67
+* Not do substring matches, so a `find first_name Mary` does not find a record with first name `"marybeth"`

0 notes on commit 284c018

Please sign in to comment.
Something went wrong with that request. Please try again.