Jelajahi Sumber

Added docs for getting imgur client id set up

Kirk Trombley 5 tahun lalu
induk
melakukan
bcf9e8e438
1 mengubah file dengan 13 tambahan dan 3 penghapusan
  1. 13 3
      README.md

+ 13 - 3
README.md

@@ -31,16 +31,26 @@ these in your `secrets.toml` under the `groupme_bots` section, with your
 be in quotes).
 
 For example, if your bot ID is `456`, and your group ID is `789`, your
-`secrets.toml` needs to start with the following
+`secrets.toml` needs to contain the following
 
 ```toml
 [groupme_bots]
 789 = "456"
 ```
 
-That's it for secrets! Note that other plugins may require additional secrets,
+Note that other plugins may require additional secrets,
 and that image uploads (namely with the `!seychelles` plugin), require an
-imgur client ID as well.
+imgur client ID as well. You can skip this if you will not be using the
+`upload_image` function in the `util` module, but if you will be uploading
+images, log-in to Imgur and
+[register a new Application](https://api.imgur.com/oauth2/addclient). Name
+the application Rollbot or something similar, tick the box for Anonymous
+usage without authorization, and fill in dummy values for any remaining
+fields. Click submit, and put the `Client ID` you are given on the next page
+(which can also be looked up from Account Settings > Applications) into
+your `secrets.toml`, as the value for `imgur_client_id`.
+
+That's it for secrets!
 
 Save the file and move on to deciding if you want to do your local execution
 and/or development with or without `docker`.