Skip to content

Commit

Permalink
[#46] Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Ido-Barnea committed Oct 14, 2023
1 parent 33816fd commit 2e18155
Show file tree
Hide file tree
Showing 2 changed files with 140 additions and 2 deletions.
124 changes: 122 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,123 @@
# Chess-But-Better
<div align="center">

Chess with an added layer of complexity.
<img src="assets/logo.svg" alt="logo" width="200" height="auto" />
<h1>Chess But Better</h1>

<p>
Chess with an added layer of complexity.
</p>


<!-- Badges -->
<p>
<a href="https://github.com/Ido-Barnea/Chess-But-Better/graphs/contributors">
<img src="https://img.shields.io/github/contributors/Ido-Barnea/Chess-But-Better" alt="contributors" />
</a>
<a href="">
<img src="https://img.shields.io/github/last-commit/Ido-Barnea/Chess-But-Better" alt="last update" />
</a>
<a href="https://github.com/Ido-Barnea/Chess-But-Better/network/members">
<img src="https://img.shields.io/github/forks/Ido-Barnea/Chess-But-Better" alt="forks" />
</a>
<a href="https://github.com/Ido-Barnea/Chess-But-Better/stargazers">
<img src="https://img.shields.io/github/stars/Ido-Barnea/Chess-But-Better" alt="stars" />
</a>
<a href="https://github.com/Ido-Barnea/Chess-But-Better/issues/">
<img src="https://img.shields.io/github/issues/Ido-Barnea/Chess-But-Better" alt="open issues" />
</a>
<a href="https://github.com/Ido-Barnea/Chess-But-Better/blob/master/LICENSE">
<img src="https://img.shields.io/github/license/Ido-Barnea/Chess-But-Better" alt="license" />
</a>
</p>
</div>

<br />

<!-- Table of Contents -->
# :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)

<!-- About the Project -->
## :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.

<!-- Features -->
### :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!**


<!-- Getting Started -->
## :toolbox: Getting Started

<!-- Run Locally -->
### :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
```

<!-- Contributing -->
## :wave: Contributing

<a href="https://github.com/Ido-Barnea/Chess-But-Better/graphs/contributors">
<img src="https://contrib.rocks/image?repo=Ido-Barnea/Chess-But-Better" />
</a>

Contributions are always welcome!

<!-- FAQ -->
## :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.


<!-- License -->
## :warning: License

Distributed under the Apache-2.0 license. See LICENSE.txt for more information.
18 changes: 18 additions & 0 deletions assets/logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2e18155

Please sign in to comment.