From 5d7a85b729db329e72e173a716a1d9545e50e53a Mon Sep 17 00:00:00 2001 From: Mohammed Sohail Date: Thu, 24 Mar 2022 19:40:15 +0300 Subject: [PATCH] docs: update --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 476c8ee..d762e33 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -## cic-ussd-e2e +# cic-ussd-e2e > Mocking user interaction with cic-ussd -### Setup +## Setup **Pre-requisites** @@ -16,25 +16,25 @@ - Node.js - Install dependencies with `$ npm i` -### Running tests +## Running tests ```bash $ npm run test ``` -### Scenarios +## Scenarios | Test | Description | | ---------------- | ---------------------------- | | 1_initial_menu | Main menu > Help > Exit | | 2_display_sarafu | Main menu > My Sarafu > Exit | -#### Writing your own scenario +### Writing your own scenario - Each scenario should exit since this test suite doesn't pass around past session info - Control wait between menus with the `wait(time in ms)` function - Follow any spec -- For any traversing through menus, remember to append a `*` and the next input, this is to correctly mock AT webhooks e.g. +- For any menu traversal, remember to append a `*` before the next input, this correctly mocks AT webhooks e.g. ```bash # Initial Main menu, no input