Skip to content

Commit

Permalink
docs: Improve documentation about verify
Browse files Browse the repository at this point in the history
fix #64
  • Loading branch information
Vaelor committed Mar 21, 2021
1 parent 8c7779b commit 674f401
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,13 @@ Usage
These options already have useful defaults or are just not needed in every case.
In most cases, you won't need to modify these, especially the basepath.
If you can only use a self signed/insecure certificate, you should set
verify to False. Please double check this if you have any errors while
verify to your CA file or to False. Please double check this if you have any errors while
using a self signed certificate!
"""
'scheme': 'https',
'port': 8065,
'basepath': '/api/v4',
'verify': True,
'verify': True, # Or /path/to/file.pem
'mfa_token': 'YourMFAToken',
"""
Setting this will pass the your auth header directly to
Expand Down Expand Up @@ -158,6 +158,9 @@ Usage
"""
foo.init_websocket(event_handler)
# Use `disconnect()` to disconnect the websocket
foo.disconnect()
# To upload a file you will need to pass a `files` dictionary
channel_id = foo.channels.get_channel_by_name_and_team_name('team', 'channel')['id']
file_id = foo.files.upload_file(
Expand Down

0 comments on commit 674f401

Please sign in to comment.