Develop

README.md

@@ -8,23 +8,37 @@ Based on the Metabase API, it helps creating Metabase resources based on YAML co
 
 This program is not a dedicated gem, you must run it using the `main.rb` file. However we'll probably enhance tests and library and then share it.
 
-First, install dependencies: 
+1. Ensure file `main.rb` has the execution rights, if not, add it : 
 ```bash
-bundle install
+chmod +x main.rb
 ```
 
-Ensure file `main.rb` has the execution rights, if not, add it : 
+2. Install dependencies: 
 ```bash
-chmod +x main.rb
+bundle install
 ```
 
-Pull the defined submodules
+3. Pull the defined submodules
+```bash
+git submodule update --recursive
+```
 
-Move `config.yml.example` to `config.yml` and replace placeholders by your configuration.
+4. Move `config.yml.example` to `config.yml` and replace placeholders by your configuration.
 
-Don't forget to setup env variables for metabase connection:
+5. Don't forget to setup env variables for Metabase connection:
 ```bash
 export METABASE_HOST="metabase.example.com" && export METABASE_USERNAME="[email protected]" && export METABASE_PASSWORD="secretpassword"
+# Also possible to put relevant variables in a .env file
+```
+You also can use a `.env` file containing the relevant informations
+```bash
+METABASE_HOST=metabase.example.com
+[email protected]
+METABASE_PASSWORD=secretpassword
+```
+and source it
+```bash
+source .env
 ```
 
 ## Usage