Skip to content

Commit

Permalink
Merge pull request #4 from Theodo-UK/master
Browse files Browse the repository at this point in the history
merge from upstream
  • Loading branch information
jnmullen authored Apr 30, 2020
2 parents 59ec29f + febd023 commit d1f0923
Show file tree
Hide file tree
Showing 18 changed files with 867 additions and 606 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,11 @@
[![Follow](https://img.shields.io/twitter/follow/SlsDevTools?style=social)](https://twitter.com/SlsDevTools)
![Maintained](https://img.shields.io/maintenance/yes/2020.svg)
[![Tweet](./img/tweetBadge.svg)](https://twitter.com/intent/tweet?text=@SlsDevTools)

<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->

[![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)

<!-- ALL-CONTRIBUTORS-BADGE:END -->

The Developer Tools for the Serverless World - think Chrome Dev Tools but for Serverless.
Expand All @@ -31,7 +34,10 @@ sls-dev-tools is currently being actively maintained. If you find a problem with
![demo](./img/demo.gif)

[Installation](#installation)\
[Usage](#usage)\
[Usage](#usage)

- [Options](#options)

[Frameworks](#frameworks)

- [Serverless framework](#serverless-framework)
Expand All @@ -55,7 +61,7 @@ sls-dev-tools is currently being actively maintained. If you find a problem with

[A note on AWS API calls and pricing](#a-note-on-aws-api-calls-and-pricing)\
[Libs](#libs)\
[Core Team](#core-team)
[Contributors ✨](#contributors-✨)

## Installation

Expand All @@ -66,7 +72,11 @@ sls-dev-tools is currently being actively maintained. If you find a problem with

![installTool](./img/startTool.gif)

Run `sls-dev-tools` in the directory with your serverless.yml
Run `sls-dev-tools` in your serverless project directory.

If the tool isn't able to find the stack name or region in local files or in the command arguments, it will open up a wizard to allow you to select the region and any available stacks.

![argumentWizard](./img/modalWizard.gif)

### Options:

Expand All @@ -80,6 +90,7 @@ Run `sls-dev-tools` in the directory with your serverless.yml
-i, --interval <interval> interval of graphs, in seconds
-p, --profile <profile> aws profile name to use
-h, --help output usage information
-s, --stage <stage> if using the serverless framework uses this as the stage option
-l, --location location of your serverless project (default is current directory)
--sls use the serverless framework to execute commands
--sam use the SAM framework to execute commands
Expand Down Expand Up @@ -233,6 +244,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
6 changes: 5 additions & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,11 @@ sidebar_label: Installation and use

![installTool](./assets/startTool.gif)

Run `sls-dev-tools` in the directory with your serverless.yml
Run `sls-dev-tools` in your serverless project directory.

If the tool isn't able to find the stack name or region in local files or in the command arguments, it will open up a wizard to allow you to select the region and any available stacks.

![argumentWizard](./assets/modalWizard.gif)

### Options:

Expand Down
Binary file added docs/assets/modalWizard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/modalWizard.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
"moment": "^2.24.0",
"node-emoji": "^1.10.0",
"open": "^7.0.3",
"prop-types": "^15.7.2"
"prop-types": "^15.7.2",
"update-notifier": "^4.1.0"
},
"devDependencies": {
"@babel/cli": "^7.5.5",
Expand Down Expand Up @@ -48,7 +49,7 @@
]
},
"description": "The Dev Tools for the Serverless World",
"version": "1.0.2",
"version": "1.0.4",
"main": "src/index.js",
"directories": {
"lib": "lib"
Expand Down
Loading

0 comments on commit d1f0923

Please sign in to comment.