From c8edc12e34cc72b84fc516e4921d269a3fd18bce Mon Sep 17 00:00:00 2001 From: counterweight Date: Wed, 2 Aug 2023 19:44:06 +0200 Subject: [PATCH] Update readme --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index c5b9add..1f61f03 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,10 @@ # camisatoshi-wordpress-reports -This repository hosts a Python CLI app that can be used to generate reports by fetching data from wordpress. It's purpose is to generate useful stuff for camisatoshi processes. \ No newline at end of file +This repository hosts a Python CLI app that can be used to generate reports by fetching data from wordpress. Its purpose is to generate useful stuff for camisatoshi processes. + + +## How to install + +1. Install the package +2. In the home directory of the running user, create a folder named `.camisatoshi-wordpress-reports`. +3. Copy the provided `.env-example` file in that directory and fill it with the required params from Woocomerce. \ No newline at end of file