fix #169 add hydrate ids note

DocNow · Sep 28, 2021 · d4f2bcc · d4f2bcc
1 parent decd541
commit d4f2bcc
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/twarc2_en_us.md b/docs/twarc2_en_us.md
@@ -211,6 +211,14 @@ twarc's `hydrate` command will read a file of tweet identifiers and write out th
 API endpoint:
 
     twarc2 hydrate ids.txt tweets.jsonl
+
+The input file, `ids.txt` is expected to be a file that contains a tweet identifier on each line, without quotes or a header:
+
+```
+919505987303886849
+919505982882844672
+919505982602039297
+```
 
 Twitter API's [Terms of Service](https://dev.twitter.com/overview/terms/policy#6._Be_a_Good_Partner_to_Twitter) discourage people from making large amounts of raw Twitter data available on the Web.  The data can be used for research and archived for local use, but not shared with the world. Twitter does allow files of tweet identifiers to be shared, which can be useful when you would like to make a dataset of tweets available.  You can then use Twitter's API to *hydrate* the data, or to retrieve the full JSON for each identifier. This is particularly important for [verification](https://en.wikipedia.org/wiki/Reproducibility) of social media research.