From 03445319606a5b122488c7102ea6fe4725dd7573 Mon Sep 17 00:00:00 2001 From: Sheng Date: Thu, 18 Apr 2019 19:54:20 +0800 Subject: [PATCH] Updated README --- README.md | 12 ++++++++++++ README.rst | 15 +++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/README.md b/README.md index de6d0c3..0c738e9 100644 --- a/README.md +++ b/README.md @@ -98,6 +98,18 @@ wssh.reset_encoding(); wssh.send('ls -l'); ``` +### Use Docker + +Start up the app +``` +docker-compose up +``` + +Tear down the app +``` +docker-compose down +``` + ### Tests Use unittest to run all tests diff --git a/README.rst b/README.rst index 9fb6ce9..9e71108 100644 --- a/README.rst +++ b/README.rst @@ -103,6 +103,21 @@ Browser console // send a command to the server wssh.send('ls -l'); +Use Docker +~~~~~~~~~~ + +Start up the app + +:: + + docker-compose up + +Tear down the app + +:: + + docker-compose down + Tests ~~~~~