From 4001ad1b63dfa2f914b99cf540e48e42e00038f4 Mon Sep 17 00:00:00 2001
From: Ioannis Pantidis
<40605232+AttackingOrDefending@users.noreply.github.com>
Date: Fri, 28 Jun 2024 08:40:48 +0300
Subject: [PATCH] Update README (#981)
---
README.md | 34 +++++++++++++++++++++++++++++-----
1 file changed, 29 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index fb1d57b00..a6cfc9bf7 100644
--- a/README.md
+++ b/README.md
@@ -1,9 +1,28 @@
-# lichess-bot
-[![Python Build](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml)
-[![Python Test](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml)
-[![Mypy](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml)
+
-A bridge between [Lichess Bot API](https://lichess.org/api#tag/Bot) and bots.
+ ![lichess-bot](https://github.com/lichess-bot-devs/lichess-bot-images/blob/main/lichess-bot-icon-400.png)
+
+
lichess-bot
+
+ A bridge between [lichess.org](https://lichess.org) and bots.
+
+ [Explore lichess-bot docs ยป](https://github.com/lichess-bot-devs/lichess-bot/wiki)
+
+
+ [![Python Build](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-build.yml)
+ [![Python Test](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/python-test.yml)
+ [![Mypy](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml/badge.svg)](https://github.com/lichess-bot-devs/lichess-bot/actions/workflows/mypy.yml)
+
+
+
+## Overview
+
+[lichess-bot](https://github.com/lichess-bot-devs/lichess-bot) is a free bridge
+between the [Lichess Bot API](https://lichess.org/api#tag/Bot) and chess engines.
+
+With lichess-bot, you can create and operate a bot on lichess. Your bot will be able to play against humans and bots alike, and you will be able to view these games live on lichess.
+
+See also the lichess-bot [documentation](https://github.com/lichess-bot-devs/lichess-bot/wiki) for further usage help.
## Features
Supports:
@@ -16,6 +35,11 @@ Supports:
- Local & Online Opening Books
- Local & Online Endgame Tablebases
+Can run on:
+- Python 3.9 and later
+- Windows, Linux and MacOS
+- Docker
+
## Steps
1. [Install lichess-bot](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-Install)
2. [Create a lichess OAuth token](https://github.com/lichess-bot-devs/lichess-bot/wiki/How-to-create-a-Lichess-OAuth-token)