Merge branch '42-working-test-case-into-readme' of https://hyde.infosys.tuwien.ac...
authorFabian Eichhorner <fabian.eichhorner@gmail.com>
Thu, 13 Dec 2018 09:09:03 +0000 (10:09 +0100)
committerFabian Eichhorner <fabian.eichhorner@gmail.com>
Thu, 13 Dec 2018 09:09:03 +0000 (10:09 +0100)
service-twitter/README.md

index a2f641be631efbb33897bf85a1fc2d3e8075bfc2..79630d0cfc7c5f3905d53be74da11ca4e624addf 100644 (file)
@@ -1,15 +1,24 @@
 # Twitter Service
 
 
+
 ## API
 
-You can use the search under: [http://localhost:8084/search/tweets.json?q=Google](http://localhost:8080/search/tweets.json?q=Google)
+You can use the search under [http://localhost:8084/search/tweets.json?q=Google](http://localhost:8080/search/tweets.json?q=Google)
 where `q` is your search string.
 
 It mainly mirrors the search API from Twitter. My implementation contains some basic fields with the same names as in
 the official API. If you need more, please let me know.
 
 
+### Example
+
+`curl -vs http://localhost:8084/search/tweets.json?q=Google `
+
+Pipe it into e.g. `jq` for a more readable output.
+
+
+
 ## API Keys
 
 Unfortunately you have to provide your own API Keys, as sharing them is forbidden. In the worst case there would be five