Skip to content

Commit

Permalink
update doc with new amp commands
Browse files Browse the repository at this point in the history
  • Loading branch information
freignat91 committed Nov 18, 2016
1 parent 50a1cef commit 7acd506
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
20 changes: 12 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,26 @@

## Starting AMP

Use the `swarm` shell script to launch amp swarm services. Available commands are:
Use the amp command `amp platform` or `amp pf` to launch amp swarm services. Available commands are:

* pull
* start
* ls
* restart
* stop
* status
* monitor

The usual workflow looks like this:

$ ./swarm pull
$ sudo ./swarm start
$ ./swarm monitor
$ sudo ./swarm restart (equivalent to stop, pull, start)
$ sudo ./swarm stop
$ amp pf pull
$ amp pf start
$ amp pf monitor (better in a separate console)
$ amp pf stop

Options:
-v --verbose To have more information messages
-s --silence To do not have message at all
-f --force Only for 'start', to force amp restart if amp is already started or do not exit on error if a service doesn't start


## CLI

Expand Down
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `examples/` directory contains example applications running from stackfiles

To run them:
- start docker
- run `./swarm pull`
- run `./swarm start`
- run `./swarm monitor` until things are up
- run `amp pf pull`
- run `amp pf start`
- run `amp pf monitor` not mandatory, but useful to follow the amp start up in another console
- follow the instructions in the README.md in the example directory

0 comments on commit 7acd506

Please sign in to comment.