Skip to content

Commit 8a9c779

Browse files
update README
1 parent 00c96bc commit 8a9c779

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,30 +37,29 @@ git clone https://github.com/FarmBot-Labs/sidecar-starter-pack
3737

3838
(2) Navigate to the project directory.
3939
```
40-
cd path/to/sidecar-starter-pack
40+
cd sidecar-starter-pack
4141
```
4242

4343
(3) Create a virtual environment.
4444
```
45-
python -m venv path/to/venv/location
45+
python -m venv py_venv
4646
```
4747

4848
(4) Activate the virtual environment.
4949
```
50-
source path/to/venv/bin/activate
50+
source py_venv/bin/activate
5151
```
5252

5353
(5) Install the required libraries within venv:
5454
```
55-
python3 -m pip install requests
56-
python3 -m pip install paho-mqtt
55+
python -m pip install requests paho-mqtt
5756
```
5857

5958
## :seedling: Getting Started
6059

61-
Import `main.py` and create an instance of the Farmbot class:
60+
Import `main` and create an instance of the Farmbot class:
6261
```
63-
from main.py import Farmbot
62+
from main import Farmbot
6463
bot = Farmbot()
6564
```
6665

@@ -190,7 +189,8 @@ sidecar-starter-pack/
190189
| class `Information()` | Description |
191190
| :--- | :--- |
192191
| `get_info()` | Get information about a specific endpoint. |
193-
| `set_info()` | Change information contained within an endpoint. |
192+
| `edit_info()` | Change information contained within an endpoint. |
193+
| `add_info()` | Create new information contained within an endpoint.
194194
| `safe_z()` | Returns the highest safe point along the z-axis. |
195195
| `garden_size()` | Returns x-axis length, y-axis length, and area of garden bed. |
196196
| `group()` | Returns all group info or single by id. |

0 commit comments

Comments
 (0)