diff --git a/README.md b/README.md index 94e3a3a8..8e85226b 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,123 @@ -# Chess-But-Better +
-Chess with an added layer of complexity. + logo +

Chess But Better

+ +

+ Chess with an added layer of complexity. +

+ + + +

+ + contributors + + + last update + + + forks + + + stars + + + open issues + + + license + +

+
+ +
+ + +# :notebook_with_decorative_cover: Table of Contents + +- [About the Project](#star2-about-the-project) + * [Features](#dart-features) +- [Getting Started](#toolbox-getting-started) + * [Run Locally](#running-run-locally) +- [Contributing](#wave-contributing) +- [FAQ](#grey_question-faq) +- [License](#warning-license) + + +## :star2: About the Project +Chess But Better acts as multiple additional layers on top of your average chess game. This innovative project aims to take the timeless game of chess and infuse it with a touch of excitement, complexity, and creativity. By incorporating a set of unique features, Chess But Better offers anyone the opportunity to explore a chess experience unlike any other. + + +### :dart: Features +- **Secret Rules:** The game introduces random additional rules, which remain hidden until triggered. +- **Extra Pieces:** Discover unique and powerful new pieces, each with its own advantages and drawbacks. +- **Items:** Make strategic use of various items on the chessboard to gain temporary advantages. +- **Varied Chess Boards**: Explore multiple distinct boards, each offering unique gameplay experiences. +- **Shopping System:** Spend your earned gold to purchase new items and pieces. +- **Upgrades System:** Utilize Experience Points to enhance and evolve your chess pieces into more powerful variants. +- **And a lot more!** + + + +## :toolbox: Getting Started + + +### :running: Run Locally + +Clone the project + +```bash + git clone https://github.com/Ido-Barnea/Chess-But-Better.git +``` + +Go to the project directory + +```bash + cd Chess-But-Better +``` + +Install dependencies + +```bash + npm install +``` + +Start the server + +```bash + npm start +``` + + +## :wave: Contributing + + + + + +Contributions are always welcome! + + +## :grey_question: FAQ + +- What is Chess But Better? + + Chess But Better is an innovative chess project that enhances the traditional game by introducing multiple extra layers of complexity on top of the rules of chess. + +- How can I play Chess But Better? + + You can access Chess But Better by cloning this repository and following the [setup instructions](#running-run-locally). + +- Is Chess But Better suitable for all skill levels? + + Yes, Chess But Better is designed to cater to players of all skill levels. Whether you're a novice or a seasoned chess enthusiast, there's something for everyone to enjoy. + +- Can I contribute to Chess But Better? + + Absolutely! Chess But Better is an open-source project, and we welcome contributions from developers and chess enthusiasts. + +- How often is Chess But Better updated with new features or content? + + The frequency of updates may vary, but we are committed to regularly enhancing and expanding the project based on community feedback and contributions. + + + +## :warning: License + +Distributed under the Apache-2.0 license. See LICENSE.txt for more information. \ No newline at end of file diff --git a/assets/logo.svg b/assets/logo.svg new file mode 100644 index 00000000..1b79a791 --- /dev/null +++ b/assets/logo.svg @@ -0,0 +1,18 @@ + + + + + + + + + +