Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
drewgendreau committed Jun 13, 2014
1 parent d4dcb0e commit 288e0e4
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The Socrata API consists of a single function, `socrata`, which at a minimum tak
df = socrata("http://soda.demo.socrata.com/resource/4334-bgaj")
````

The `url` may be a [Socrata API Endpoint] or may be common url found in the address bar (in which case Socrata.jl will automatically attempt to parse the string into a usable format). For example, the following are all valid urls for the same dataset:
The `url` may be a [Socrata API Endpoint](http://dev.socrata.com/docs/endpoints.html) or may be common url found in the address bar (in which case Socrata.jl will automatically attempt to parse the string into a usable format). For example, the following are all valid urls for the same dataset:

`http://soda.demo.socrata.com/resource/4334-bgaj`
`http://soda.demo.socrata.com/resource/4334-bgaj.json`
Expand Down Expand Up @@ -101,3 +101,10 @@ df = socrata(url, app_token=token, q="Hawaii")
````julia
df = socrata(url, app_token=token, q="hawaii", where="magnitude > 2", select="datetime, magnitude, region, location")
````

## TODO

* Add support for automatically getting API Field IDs
* Implement better app_token system
* Add support for JSON and XML

0 comments on commit 288e0e4

Please sign in to comment.