From 6ffbc7fedf4ff0d1e192b3222db3ce0660a8e49a Mon Sep 17 00:00:00 2001 From: Owen Date: Sat, 14 Dec 2024 00:18:36 +0100 Subject: [PATCH] readme update --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5e4efc2..4beed10 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# PlantIdDiscordBot +# Plant ID Discord Bot + +## A plant identification bot for your Discord server. + +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 idendifications 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 + +- 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] and [PFAF] for the identified plant + +## Prerequisites + +List here