Comments

README.md

@@ -22,6 +22,7 @@ Ask questions in the matrix chat [#halcyon:blackline.xyz](https://matrix.to/#/#h
     - join_room(roomID)
     - download_media(mxc)
     - upload_media(fileBuffer, fileName)
+    - send_image(roomID, fileBuffer, fileName, generate_blurhash, generate_thumbnail)
 - Room and message objects for incoming events events
 - Basic documentation (Check [usage.md](./usage.md))
 
@@ -33,6 +34,9 @@ Ask questions in the matrix chat [#halcyon:blackline.xyz](https://matrix.to/#/#h
 
 ## Example bot code
 See more example and message object info in [usage.md](./usage.md)
++ [Example message bot](./examples/basic_message_bot.py), looks for a phrase and replies with a phrase
++ [Example image bot](./examples/basic_image_bot.py), looks for a phrase and replies with an image
++ [Image Archive bot](./examples/image_archive_bot.py), looks for images, and saves them
 ```python
 import halcyon
 import requests, json

src/halcyon/halcyon.py

@@ -338,7 +338,7 @@ async def send_image(self, roomID, fileBuffer, fileName, generate_blurhash=True,
             @param roomID String the room to send to
             @param file BytesIO The file in bytes format
             @param fileName String the file name of the file
-            @param generate_blurhash Bool Generate a Bluehash for the image. This is a blur used as filler while the image loads
+            @param generate_blurhash Bool Generate a Blurhash for the image. This is a blur used as filler while the image loads
             @param generate_thumbnail Bool Set to true to automatically downsize images over 640x640
         """
         fileBuffer = io.BytesIO(fileBuffer)

usage.md

@@ -71,7 +71,7 @@ if __name__ == '__main__':
 
 [Example message bot](./examples/basic_message_bot.py), looks for a phrase and replies with a phrase
 [Example image bot](./examples/basic_image_bot.py), looks for a phrase and replies with an image
-[Image Archive bot](./examples/image_archive_bot.py), Looks for images, and saves them
+[Image Archive bot](./examples/image_archive_bot.py), looks for images, and saves them
 
 ## halcyon function documentation
 + `client.send_message`
@@ -100,7 +100,7 @@ if __name__ == '__main__':
     + @param `roomID` String the room to send to
     + @param `fileBuffer` BytesIO The file in bytes format
     + @param `fileName` String the file name of the file
-    + @param `generate_blurhash` Bool Generate a Bluehash for the image. This is a blur used as filler while the image loads. Defaults True
+    + @param `generate_blurhash` Bool Generate a Blurhash for the image. This is a blur used as filler while the image loads. Defaults True
     + @param `generate_thumbnail` Bool Set to true to automatically downsize images over 640x640. Defaults True
 
 ## halcyon event handlers