From 8f8b52740e20bf17863c30c902f5813ba093573f Mon Sep 17 00:00:00 2001
From: Owen <owenrees82@gmail.com>
Date: Tue, 14 Jan 2025 09:52:37 +0100
Subject: [PATCH] updated installation

---
 README.md | 28 ++++++++++++++++++++++------
 1 file changed, 22 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 06c9098..31feffa 100644
--- a/README.md
+++ b/README.md
@@ -4,16 +4,18 @@
 
 Plant ID Bot identifies plants from photos of their organs, passing to the [Plantnet API] for identification. This bot was written for [Sustainable Living Hub](https://discord.com/invite/gQU5yWg)
 
-If you wish to invite this bot to your server, use [this link.](https://discord.com/api/oauth2/authorize?client_id=948227126094598204&permissions=19520&scope=bot) However, your server will be limited to a maximum of 20 identifications every 24h. It is strongly preferred that you host a version of this bot yourself and register for your own PlantNet API key. Details for this are later in this readme file.
+If you wish to invite this bot to your server, use [this link.](https://discord.com/api/oauth2/authorize?client_id=948227126094598204&permissions=19520&scope=bot) However, your server will be limited to a maximum of 10 identifications every 24h. It is strongly preferred that you host a version of this bot yourself and register for your own PlantNet API key. Details for this are later in this readme file.
 
-## Features
+### Features
 
 - Takes the message picture attachments and attempts to identify them
 - Returns a suggested plant name and up to 2 alternatives, with a percentage confidence rating
 - Plant names are given in latin with a list of possible common names
 - Provides links to [GBIF], [PFAF], and [POWO] for the identified plant
 
-## Dependencies
+### Dependencies
+
+This application has been built and tested with Elixir 1.16 / OTP 26.
 
 ```elixir
 # mix.exs
@@ -25,13 +27,15 @@ defp deps do
       {:httpoison, "~> 2.2"},
       {:image, "~> 0.55"},
       {:jason, "~> 1.4"},
+      {:logger_webhook_backend, "~> 0.0.2"},
+      {:plug, "~> 1.12"},
       {:plug_cowboy, "~> 2.7"},
       {:quantum, "~> 3.5"}
     ]
   end
 ```
 
-## Environment Variables
+### Environment Variables
 
 Below are the environment variables that you need to set for the program to function:
 
@@ -42,9 +46,21 @@ PLANTNET_API_KEY=                    API key for the PlantNet service
 PLANTID_FILESERVER_URL               URL and port(if needed) for the http file server
 ```
 
-## Installation
+### Installation
 
-TODO
+#### Prerequisites
+
+- Have a VPS ready to host this application on
+- Visit [PlantNet Api] and create your own API key
+- Visit [Discord Developer Portal](https://discord.com/developers/) and create a new application as a bot. Give it permissions to read and send messages, use application commands, and to create embeds. Enable `Message Content Intent`. Keep note of the `Bot Token`.
+
+#### then...
+
+- Clone this GitHub repository locally
+- Add the above environment variables to you GitHub actions secrets, as well as SSH keys for your VPS, username, host, and port
+- Change the target OS version if required.
+- Force the GitHub action to run, allowing it to deploy on your server
+- Start the application on your VPS with `your_folder_name/current_release/bin/plantid_discord_bot daemon`
 
 ## Development