Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
veloce committed Jul 23, 2024
1 parent 63bd163 commit efc93e7
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,16 @@ chess logic so you can use it with different chess variants.

## Getting started

This package exports a `Chessboard` widget which can be interactable or not. It is
entirely configurable with a `BoardSettings` object.
This package exports a `Chessboard` widget which can be interactable or not.

It is configurable with a `ChessboardSettings` object which defines the board
behavior and appearance.

You must provide a `ChessboardState` object to the `Chessboard` widget. This
object is immutable and contains the board state (the position, which side has
to move, etc.).
All chess logic must be handled outside of this package. Any change in the state
of the game needs to be transferred to the board by creating a new `ChessboardState` object.

## Usage

Expand Down

0 comments on commit efc93e7

Please sign in to comment.