diff --git a/docs/README.md b/docs/README.md index 73ff27601..2ab2e9890 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 diff --git a/examples/README.md b/examples/README.md index cc387cbc3..f1ca1074d 100644 --- a/examples/README.md +++ b/examples/README.md @@ -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 \ No newline at end of file