Skip to content

Commit

Permalink
Testing badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Juliana Mashon authored and Juliana Mashon committed Aug 6, 2024
1 parent 4f736da commit b4751d9
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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.
```
Expand Down Expand Up @@ -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.
```
Expand Down Expand Up @@ -113,7 +111,7 @@ bot.get_token('email', 'password', 'server')
| Jobs | Description |
| :--- | :--- |
| `get_job()` | [BROKER] |
| `get_job()` | [BROKER] <a href="https://developer.farm.bot/v15/docs/web-app/rest-api.html"><img src="https://img.shields.io/badge/REST%20API-FF9500"/></a> |
| `set_job()` | [BROKER] |
| `complete_job()` | [BROKER] |

Expand Down

0 comments on commit b4751d9

Please sign in to comment.