From 95a4039e6372d01b029559d91c5cff2cccb6f4b0 Mon Sep 17 00:00:00 2001 From: jalpp <92553013+jalpp@users.noreply.github.com> Date: Mon, 22 Apr 2024 17:58:18 -0400 Subject: [PATCH] clean up readme --- CONTRIBUTING.md | 27 +++++++++++++++++++ README.md | 6 ++--- .github/commands.md => commands.md | 0 ...privacy-policy.md => tos-privacy-policy.md | 0 4 files changed, 29 insertions(+), 4 deletions(-) rename .github/commands.md => commands.md (100%) rename .github/tos-privacy-policy.md => tos-privacy-policy.md (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3fe69b..69b6367 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,3 +19,30 @@ - Please note you need to follow the same steps as adding Chesslise for your own local bot - build the project ``` mvn package ``` - run the application ``` java -jar /target/Chesslise-13.5-SNAPSHOT-jar-with-dependencies.jar ``` + + +# API + + 1. [Lichess API](https://lichess.org/api) + 2. [Chess.com API](https://github.com/sornerol/chess-com-pubapi-java-wrapper) + 3. [JDA 5 Discord API](https://github.com/DV8FromTheWorld/JDA) + 4. [StockFish API](https://stockfish.online/) + 5. [Fide API](https://github.com/lenguyenthanh/fide?tab=readme-ov-file) + +# Libraries + + 1. [Lichess Java Client](https://github.com/tors42/chariot) + 2. [Tors42 JBang-chariot Java Client Examples](https://github.com/tors42/jbang-chariot) + 3. [Chess.com Java Wrapper](https://github.com/sornerol/chess-com-pubapi-java-wrapper) + 4. [Java Chess Lib](https://github.com/bhlangonijr/chesslib) + +# Engines + +- [Lise Chess Engine](https://github.com/jalpp/LiseChessEngine) +- [Stockfish](https://stockfishchess.org/) + +# Image Generation +- [Lichess Gifs](https://github.com/lichess-org/lila-gif) + +# Chesslise High-level Design +![Lisev10B drawio](https://github.com/jalpp/LichessSearchEngineBot/assets/92553013/ab1aa349-135b-4f57-a592-bba4e6faf733) diff --git a/README.md b/README.md index f0be35c..545f689 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ ![](https://img.shields.io/badge/Status-Online-brightgreen) ![](https://img.shields.io/badge/Discord%20API-JDA-purple) ![](https://img.shields.io/badge/Available%20On-Discord%20App%20Directory%20-blue) +![GitHub License](https://img.shields.io/github/license/jalpp/Chesslise) + Chesslise is open source Chess based Discord application, which allows users to play, learn, and watch chess on their Discord server @@ -30,8 +32,6 @@ Chesslise is open source Chess based Discord application, which allows users to # Image Generation - [Lichess Gifs](https://github.com/lichess-org/lila-gif) -# Chesslise High-level Design -![Lisev10B drawio](https://github.com/jalpp/LichessSearchEngineBot/assets/92553013/ab1aa349-135b-4f57-a592-bba4e6faf733) # Popular Commands | Commands | Description | @@ -40,8 +40,6 @@ Chesslise is open source Chess based Discord application, which allows users to | /analyze | analyze positions | | /play | create live chess games in Discord | - - ## App Directory [View More](https://discord.com/application-directory/930544707300393021) diff --git a/.github/commands.md b/commands.md similarity index 100% rename from .github/commands.md rename to commands.md diff --git a/.github/tos-privacy-policy.md b/tos-privacy-policy.md similarity index 100% rename from .github/tos-privacy-policy.md rename to tos-privacy-policy.md