diff --git a/README.md b/README.md index c307239..68dd110 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ # League of Women Voters of West Virginia -Custom developed software for the League of Women Voters of West Virginia \ No newline at end of file +Custom developed software for the League of Women Voters of West Virginia + +## LLAW Google Civic Information API Query version 1 +Copyright (C) 2023 - by Jonathan Rosenbaum + +This may be freely redistributed under the terms of the GNU General Public License + + Usage: ./google-civic-api.pl google ./roster-file (queries Google Civic Api Delegate and Senate District for all LWVWV members) + ./google-civic-api.pl WV000 ./roster-file email (show all information for members at large, but do not query Google) + ./google-civic-api.pl WV000 ./roster-file email (only show email addresses for members at large, but do not query Google) + + 1st argument can be one of these types: + google (all members with senate/delegate district query) which prints out this csv data: + 'Name,Email,Phone,Address,Join Date,Delegate District,Senate District,' + ALL (all members without senate/delegate district query) + League ID: WV000 (members at large) WV102 (Huntington) WV103 (Morgantown-Monogalia) WV107 (Wood County) WV112 (Jefferson) + + 2nd argument must be the location of the LWVWV roster file, and prints out this csv information: + Name,Email,Phone,Address,Join Date, + + 3rd argument 'email' will only print out the email addresses, and only works with the ALL or League ID type argument + + You will want to send results to a file. + Example: ./google-civic-api.pl google ./roster-file > 2023-districts \ No newline at end of file