Skip to content

Commit b4751d9

Browse files
Juliana MashonJuliana Mashon
Juliana Mashon
authored and
Juliana Mashon
committed
Testing badges
1 parent 4f736da commit b4751d9

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

README.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# sidecar-starter-pack
2+
Authentication and communication utilities for FarmBot sidecars
23

34
[![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)
45
[![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)
56

6-
Authentication and communication utilities for FarmBot sidecars
7-
87
## :book: Contents
8+
99
* [Installation](#computer-installation-mac-os)
1010
* [Getting Started](#seedling-getting-started)
1111
* [Get your authentication token](#get-your-authentication-token)
@@ -14,7 +14,6 @@ Authentication and communication utilities for FarmBot sidecars
1414
* [Formatting message broker messages](#formatting-message-broker-messages)
1515

1616
## :computer: Installation (Mac OS)
17-
To set up the project locally, follow these steps:
1817

1918
Step 1: Clone the repository.
2019
```
@@ -45,7 +44,6 @@ python3 -m pip install paho-mqtt
4544
## :seedling: Getting Started
4645

4746
### Get your authentication token
48-
To generate your authentication token and get started:
4947

5048
Step 1: Import `main.py` and create an instance.
5149
```
@@ -113,7 +111,7 @@ bot.get_token('email', 'password', 'server')
113111
114112
| Jobs | Description |
115113
| :--- | :--- |
116-
| `get_job()` | [BROKER] |
114+
| `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> |
117115
| `set_job()` | [BROKER] |
118116
| `complete_job()` | [BROKER] |
119117

0 commit comments

Comments
 (0)