From 1634708f14e29f989eefd2945af1fe1d7eb775b8 Mon Sep 17 00:00:00 2001 From: Eduardo Hattori Date: Thu, 19 May 2022 10:51:10 -0300 Subject: [PATCH] chore: add cli documentation --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6159f00..112af68 100644 --- a/README.md +++ b/README.md @@ -73,15 +73,20 @@ class ConsumerExampleClass ## Fill with your business logic here end end +``` + +### Start PipefyMessages Consumer +To start `consumer` inside a Rails applications: -ConsumerExampleClass.process_message +```shell +bundle exec pipefymessage -w ConsumerExampleClass -R ``` ### Development - Test To test changes without installing this dependency on your application, on your terminal go to the project root and execute: -```console +```shell export ENABLE_AWS_CLIENT_CONFIG=true make build-app @@ -90,13 +95,13 @@ To test changes without installing this dependency on your application, on your If you need to recreate the infra (SNS and SQS) run: -```console +```shell make recreate-app-infra ``` After that, we are going to test the gem with these commands: -```console +```shell irb ```