diff --git a/README.md b/README.md index e96121f..0a0d289 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,29 @@ Social Networks data analysis utilities and tools, starting with Twitter. To install, first install [ExoRepo](https://code.tupale.co/Offray/ExoRepo) and then from a _playground_ in [GToolkit](https://gtoolkit.com/) execute: ```smalltalk - ExoRepo new - repository: 'https://code.tupale.co/Offray/Datanalitica'; - load. -``` \ No newline at end of file + ExoRepo new + repository: 'https://code.tupale.co/Offray/Datanalitica'; + load. +``` + +## Minimal usage example + +**Prerequisite**: You will need to have already your [Twitter API Keys](https://developer.twitter.com/en/support/twitter-api). + +Load your API keys into a `TwitterAPI` object: + +```smalltalk + twitterAPI := TwitterAPI new + apiKeysFile: FileLocator home / 'Route/To/myAPIKeysFile.json'; + loadKeys. +``` + + (If you don't define a particular route to your API keys file, it will be loaded from a default location + in : `~/.config/Datanalitica/twitter-api-keys.json`) + + Once you have loaded your keys, you can run your first query using the DSL (Domain Specific Lanuage): + +```smalltalk + twitterAPI usersGroupMentioning: 'feenkcom' +``` +