Skip to content

Commit 466bb32

Browse files
committed
0.6.0
1 parent 1853dca commit 466bb32

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

README.md

+13-6
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@
1010

1111
![sammie](https://user-images.githubusercontent.com/411908/35882654-ea43468a-0b52-11e8-9a0c-d5d721e56a51.gif)
1212

13+
---
14+
1315
### Prerequisites
1416

1517
[AWS CLI](https://aws.amazon.com/cli/) - sammie uses this for all AWS operations under the hood.
@@ -24,34 +26,39 @@ sammie deploy
2426

2527
This will generate a basic serverless application, deploy it to a development environment, and direct you to your app served over https!
2628

29+
---
30+
2731
### Commands
2832

2933
#### init - Generates a serverless application including a SAM template & lambda function
3034

31-
`sammie init <name>`
35+
`sammie init <name>`
3236
_Options:_
3337
`-y, --yaml`: Generate yaml for SAM template. Defaults to json, because javascript.
3438

3539
#### deploy - Deploys application
3640

37-
`sammie deploy`
41+
`sammie deploy`
3842
_Options:_
3943
`-t, --template`: Path to a SAM template. Defaults to `sam.(json|yaml)` in the current directory.
4044
`-e, --environment`: An environment name to deploy. Defaults to "development".
4145
`-p, --parameters`: A list of parameters to override in your template.
4246

47+
---
48+
4349
### Environments
4450

4551
It's a best practice to create completely separate stacks for each of your application's environments, rather than a single stack with multiple lambda qualifiers, API Gateway stages, and permissions. This makes your application more portable and reduces the blast radius of taking down your live application during the development cycle.
4652

47-
To support this, sammie will deploy separate stacks for you based on your environment option.
48-
E.g. your stack name is "my-app":
49-
`sammie deploy` will deploy stack "my-app-development"
53+
To support this, sammie will deploy separate stacks for you based on the environment option:
54+
55+
E.g. your stack name is "my-app":
56+
`sammie deploy` will deploy stack "my-app-development" (development is the default)
5057
`sammie deploy --environment production` will deploy stack "my-app-production"
5158

5259
#### Environment variables & properties
5360

54-
To add environemnt specific variables & properties, you can create separate sam templates named with the environemnt suffix.
61+
To add environemnt specific variables & properties, create separate sam templates named with the environemnt suffix.
5562
E.g. `sam-production.json` containing the following, will get merged with your base template `sam.json` upon `sammie deploy --environment production`
5663

5764
```json

package-lock.json

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "sammie",
3-
"version": "0.5.0",
3+
"version": "0.6.0",
44
"description": "Serverless Application Model Made Infinitely Easier",
55
"license": "MIT",
66
"author": "Garth Poitras <[email protected]>",

0 commit comments

Comments
 (0)