Docs, version bump

Author: rabdill

CHANGELOG.md

@@ -1,7 +1,8 @@
 # go-congress CHANGELOG
 
-## Unreleased
+## 0.1.0
 
 - Storing connection information to the ProPublica API
-- Fetching a list of all members of a chamber in a particular session of Congress, or all current members from a state
+- Fetching a list of all members of a chamber in a particular session of Congress, or all current members from a state/district
+- Fetching a list of incoming or outgoing members
 - Fetching detailed information about one member

README.md

@@ -1,3 +1,58 @@
 # ProPublica Congress API Go SDK
 
-A Golang API client for interacting with the [ProPublica Congress API](https://www.propublica.org/datastore/api/propublica-congress-api), which provides access to some of the most extensive data available about the United States Congress, both its current sessions and going decades into the past. **This library is in no was affiliated with ProPublica or Congress.**
+A Golang API client for interacting with the [ProPublica Congress API](https://www.propublica.org/datastore/api/propublica-congress-api), which provides access to some of the most extensive data available about the United States Congress, both its current sessions and going decades into the past. **This library is in no was affiliated with ProPublica or Congress.**
+
+## Getting started
+
+Add `import "github.com/rabdill/go-congress/congress"` to the top of your script or application file, with the rest of your imports. From there, all you need to start making calls is a client:
+
+```go
+c := congress.Client{
+    Endpoint: "https://api.propublica.org/congress/v1",
+    Key:      "KEYgoesHERE123",
+}
+```
+
+(You can request a free API key from ProPublica [on their website](https://www.propublica.org/datastore/api/propublica-congress-api), which also has the [API documentation](https://projects.propublica.org/api-docs/congress-api/).)
+
+Authenticating to the Congress API is simple and happens without intervention; you can jump right into making calls now:
+
+```go
+members, _ := c.GetDepartingMembers(115, "senate")
+```
+
+If you just want to test things out (and make sure your key is working), you can create a file called `main.go` in the root of this repository and paste this code in:
+
+```go
+package main
+
+import (
+	"fmt"
+
+	"github.com/rabdill/go-congress/congress"
+)
+
+func main() {
+	c := congress.Client{
+		Endpoint: "https://api.propublica.org/congress/v1",
+		Key:      "KEYgoesHERE123",
+	}
+	// answer, err := c.GetMembers(115, "senate")
+	// answer, err := c.GetMember("K000388")
+
+	// answer, err := c.GetChamberMembersByState("nj", "house")
+	// answer, err := c.GetChamberMembersByDistrict("nj", 1, "senate")
+	// answer, err := c.GetMembersByState("nj")
+
+	// answer, err := c.GetNewMembers()
+	answer, err := c.GetDepartingMembers(115, "senate")
+	if err != nil {
+		fmt.Printf("\nOh no!\n|%s|\n", err)
+    }
+    
+    fmt.Printf("\nRESULT COUNT: |%v|", len(answer))
+	fmt.Printf("\n\n\n!!!RESULTS!!!\n\n%+v\n", answer)
+}
+```
+
+From there, all you'll need to do is run `go run main.go` and it should print out a list of members departing the current Senate. Uncommenting any of the other calls will give you different sets of results.

congress/member.go

@@ -35,7 +35,7 @@ type TrackingIDs struct {
 	// politician's ID in their databases.
 	ICPSR string `json:"icpsr_id,omitempty"`
 
-	// CRP is the politician's ID from theCenter for Responsive Politics,
+	// CRP is the politician's ID from the Center for Responsive Politics,
 	// which runs OpenSecrets.org.
 	CRP string `json:"crp_id,omitempty"`
 
@@ -56,7 +56,7 @@ type MemberSummary struct {
 	Title       string `json:"title"`
 	ShortTitle  string `json:"short_title"`
 	InOffice    bool   `json:"in_office"`
-	SenateClass string `json:"senate_class,omitempty"` // TODO: Is this a different field for House members?
+	SenateClass string `json:"senate_class,omitempty"`
 	StateRank   string `json:"state_rank,omitempty"`
 	Party       string `json:"party"`
 	Leadership  string `json:"leadership_role,omitempty"`
@@ -87,9 +87,11 @@ type MemberSummary struct {
 	// DW-NOMINATE (Dynamic Weighted NOMINAl Three-step Estimation) estimation.
 	DWNominate float32 `json:"dw_nominate"`
 
-	// *tk no idea what these are
+	// IdealPoint indicates a politician's position on the left/right spectrum
 	IdealPoint string `json:"ideal_point"`
-	OCD        string `json:"ocd_id,omitempty"`
+
+	// OCD is the ID of the politician's district within the Open Civic Data project.
+	OCD string `json:"ocd_id,omitempty"`
 }
 
 // MemberDetails holds the data of a member of Congress when it is requested
@@ -126,7 +128,7 @@ type MemberSearch struct {
 
 // MemberInTransition is the format of data sent from ProPublica
 // about a single member when searching for members who are either
-// new or leaving office. It doesn't really look like the others.
+// new or leaving office. It doesn't really match the others.
 type MemberInTransition struct {
 	ID         string `json:"id"`
 	FirstName  string `json:"first_name"`