yuanbiao
/
emqx
1
0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(s3): fix README example

This commit is contained in:
Andrew Mayorov 2024-02-12 10:44:18 +01:00
parent 5b7bb89f37
commit 0edc5b5992
No known key found for this signature in database
GPG Key ID: 2837C62ACFBFED5D
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
apps/emqx_s3/README.md
View File

@ -18,7 +18,7 @@ The steps to integrate this application are:
`ProfileName` is a unique name used to distinguish different sets of S3 settings. Each profile has its own connection pool and configuration. `ProfileName` is a unique name used to distinguish different sets of S3 settings. Each profile has its own connection pool and configuration.
To use S3 from a _client_ application: To use S3 from a _client_ application:
* Create an uploader process with `{ok, Pid} = emqx_s3:start_uploader(ProfileName, #{key => MyKey})`. * Create an uploader process with `{ok, Pid} = emqx_s3:start_uploader(ProfileName, MyKey, _Opts = #{})`.
* Write data with `emqx_s3_uploader:write(Pid, <<"data">>)`. * Write data with `emqx_s3_uploader:write(Pid, <<"data">>)`.
* Finish the uploader with `emqx_s3_uploader:complete(Pid)` or `emqx_s3_uploader:abort(Pid)`. * Finish the uploader with `emqx_s3_uploader:complete(Pid)` or `emqx_s3_uploader:abort(Pid)`.