Skip to content

Commit

Permalink
adjusted README given refactoring
Browse files Browse the repository at this point in the history
  • Loading branch information
jfri3d committed Apr 14, 2019
1 parent 91b58e0 commit 221578e
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ $ pip3 install -r requirements.txt
<a name="configuration"></a>
### Configuration

Minimal configuration with a `.envrc` file is required in order to link with Slack and determine correct sunrise/sunset times (i.e. based on location).
Minimal configuration with a `.envrc` file based on `.envrc.template` is required in order to link with Slack and determine correct sunrise/sunset times (i.e. based on location).

- build a [slackbot](https://api.slack.com/bot-users)
- identify the accurate [geolocation](https://www.latlong.net/)
Expand All @@ -59,7 +59,7 @@ UU:UU:UU:UU:UU:UU (unknown)
XX:XX:XX:XX:XX:XX Flower care
```

The saved MAC address(es) need to be saved into the `plant_def.json` file containing the following schema. Note that the default definition file naming can be changed in `constants.py`.
The saved MAC address(es) need to be saved into the `./data/plant_def.json` file containing the following schema. Note that the default definition file naming can be changed in `./scripts/constants.py`.

```json
{
Expand All @@ -85,8 +85,8 @@ The saved MAC address(es) need to be saved into the `plant_def.json` file contai

The two running processes for running PlantBot are as follows:

- `plantbot.py` - responsible for daily scheduling of "reading" raw plant measurements
- `slackbot_alert.py` - responsible for alerting via Slack which plant needs to be watered
- `./scripts/plantbot.py` - responsible for daily scheduling of "reading" raw plant measurements
- `./scripts/slackbot_alert.py` - responsible for alerting via Slack which plant needs to be watered

These processes are deployed with supervisor, see [this guide](https://www.vultr.com/docs/installing-and-configuring-supervisor-on-ubuntu-16-04) for installation and setup.

Expand Down

0 comments on commit 221578e

Please sign in to comment.