search

cfpb / grasshopper-parser

Address Parsing REST API
Creative Commons Zero v1.0 Universal
8 stars 8 forks source link

Update README With Latest Refactorings #38

Closed hkeeler closed 8 years ago

hkeeler commented 8 years ago

Adds docs for changes to the API and the new rules.yaml config file.

awolfe76 commented 8 years ago

@hkeeler - I commented on the few GETs but there are also other areas in the README that could be in code blocks as well. For example:

https://github.com/cfpb/grasshopper-parser/pull/38/files#diff-04c6e90faac2675aa89e2176d2eec7d8R45 https://github.com/cfpb/grasshopper-parser/pull/38/files#diff-04c6e90faac2675aa89e2176d2eec7d8R49

We did that in the grasshopper README.

hkeeler commented 8 years ago

@awolfe76, I'm not sure I follow? Are you asking why I haven't wrapped these sections in code blocks? If you pad with 4 spaces, it is the equivalent. I generally use that form for one-lines, and do the for longer blocks. You can check out the rendered version here:

I can switch them all over to the other form if you feel its confusing in its current mixed form.

awolfe76 commented 8 years ago

Ummm, yeah. I'm a fool. :grimacing:

Merging.