From b4751d9c4ffacbda754c468e1dead9bdf4ce898a Mon Sep 17 00:00:00 2001 From: Juliana Mashon Date: Tue, 6 Aug 2024 14:40:32 -0700 Subject: [PATCH] Testing badges --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index b2b8eda..ece74aa 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # sidecar-starter-pack +Authentication and communication utilities for FarmBot sidecars [![Test Status](https://github.com/FarmBot-Labs/sidecar-starter-pack/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/FarmBot-Labs/sidecar-starter-pack/actions?query=branch%3Amain) [![Coverage Status](https://coveralls.io/repos/github/FarmBot-Labs/sidecar-starter-pack/badge.svg?branch=main)](https://coveralls.io/github/FarmBot-Labs/sidecar-starter-pack?branch=main) -Authentication and communication utilities for FarmBot sidecars - ## :book: Contents + * [Installation](#computer-installation-mac-os) * [Getting Started](#seedling-getting-started) * [Get your authentication token](#get-your-authentication-token) @@ -14,7 +14,6 @@ Authentication and communication utilities for FarmBot sidecars * [Formatting message broker messages](#formatting-message-broker-messages) ## :computer: Installation (Mac OS) -To set up the project locally, follow these steps: Step 1: Clone the repository. ``` @@ -45,7 +44,6 @@ python3 -m pip install paho-mqtt ## :seedling: Getting Started ### Get your authentication token -To generate your authentication token and get started: Step 1: Import `main.py` and create an instance. ``` @@ -113,7 +111,7 @@ bot.get_token('email', 'password', 'server') | Jobs | Description | | :--- | :--- | -| `get_job()` | [BROKER] | +| `get_job()` | [BROKER] | | `set_job()` | [BROKER] | | `complete_job()` | [BROKER] |