Skip to content

Commit f550c1f

Browse files
committed
updated docs
1 parent b61ec13 commit f550c1f

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,14 @@ This will create a package and leave it in the project directory.
5252
```shell
5353
lambda-uploader --no-upload ./myfunc
5454
```
55+
56+
To publish a version without an alias you would pass the the publish flag.
57+
```shell
58+
lambda-uploader -p ./myfunc
59+
```
60+
61+
If you would like to alias your upload you can pass the alias with the alias flag. The
62+
function description will be used when an alias-description is not provided.
63+
```shell
64+
lambda-uploader --alias myAlias --alias-description 'My alias description' ./myfunc
65+
```

README.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,32 @@ directory or with the directory as an option.
5656
5757
lambda-uploader ./myfunc
5858
59+
To specify an alternative profile that has been defined in
60+
``~/.aws/credentials`` use the ``--profile`` parameter.
61+
62+
.. code:: shell
63+
64+
lambda-uploader --profile=alternative-profile
65+
5966
If you would prefer to upload another way you can tell the uploader to
6067
ignore the upload. This will create a package and leave it in the
6168
project directory.
6269

6370
.. code:: shell
6471
6572
lambda-uploader --no-upload ./myfunc
73+
74+
To publish a version without an alias you would pass the the publish
75+
flag.
76+
77+
.. code:: shell
78+
79+
lambda-uploader -p ./myfunc
80+
81+
If you would like to alias your upload you can pass the alias with the
82+
alias flag. The function description will be used when an
83+
alias-description is not provided.
84+
85+
.. code:: shell
86+
87+
lambda-uploader --alias myAlias --alias-description 'My alias description' ./myfunc

0 commit comments

Comments
 (0)