Skip to content

Commit 582aa89

Browse files
authored
Update README.md
1 parent df07c87 commit 582aa89

File tree

1 file changed

+79
-2
lines changed

1 file changed

+79
-2
lines changed

README.md

Lines changed: 79 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,83 @@
11
# serviceless
22

33
[![Build Status](http://circleci-badges-max.herokuapp.com/img/8bites/serviceless?token=4482e2625fab30eeca954eec94a73091532f7883)](https://circleci.com/gh/8bites/serviceless) [![codecov](https://codecov.io/gh/8bites/serviceless/branch/master/graph/badge.svg)](https://codecov.io/gh/8bites/serviceless)
4-
[![npm](https://img.shields.io/npm/v/npm.svg)](https://www.npmjs.com/package/serviceless)
4+
[![npm version](https://badge.fury.io/js/serviceless.svg)](https://badge.fury.io/js/serviceless)
5+
[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
56

6-
> Cli tool on top of Serverless framework
7+
**Serviceless** - cli tool on top of Serverless framework, that simplifies workflow with multiple services.
8+
9+
Quick start
10+
===
11+
12+
<img align="right" width="400" src="./assets/deploy_all.gif" />
13+
14+
1. Install serverless framework
15+
```sh
16+
npm install serverless
17+
```
18+
2. Install serviceless cli
19+
```sh
20+
npm install serviceless
21+
```
22+
3. Deploy
23+
```sh
24+
slx deploy all
25+
```
26+
27+
How to
28+
===
29+
30+
Deploy
31+
------
32+
33+
#### Deploy all services in a folder
34+
```sh
35+
slx deploy all
36+
```
37+
38+
#### Deploy service with command line prompt
39+
40+
```sh
41+
slx deploy
42+
```
43+
then select service or folder from the list.
44+
45+
#### Deploy service, matching string
46+
47+
```sh
48+
slx deploy <query>
49+
```
50+
51+
#### Flags
52+
53+
`-b`, `--runInBand` - deploy services one by one (parallel by default)
54+
55+
`-e`, `--exitOnFailure` - stop deployment of other services on failure
56+
57+
Help
58+
------
59+
```sh
60+
slx --help
61+
slx deploy --help
62+
```
63+
64+
What's next
65+
===
66+
67+
- [ ] aggregate logs for multiple services
68+
- [ ] add configuration file to deploy in band services that rely on each other
69+
70+
Contributions
71+
===
72+
73+
Yes, please!
74+
75+
Clone repo, then
76+
```sh
77+
npm install
78+
npm test
79+
```
80+
81+
LICENCE
82+
===
83+
MIT

0 commit comments

Comments
 (0)