Skip to content

Commit

Permalink
Updates README.
Browse files Browse the repository at this point in the history
  • Loading branch information
marianogappa authored Mar 18, 2020
1 parent 4035886 commit d2f220c
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,20 @@
# cheesse
Simple package, server and CLI tool for all things Chess.
Simple package, server and CLI tool (and WebAssembly bindings) for all things chess.

Please note that this library is NOT YET ready for mainstream use. Its API is not final, two of its API methods are not fully implemented, and it hasn't yet been battletested against a massive corpus of games (only about 300).

## API

```go
DefaultGame() OutputGame
ParseGame(game InputGame) (OutputGame, error)
DoAction(game InputGame, action InputAction) (OutputGame, OutputAction, error)

// Currently only supporting Algebraic Notation; others coming soon
ParseNotation(game InputGame, notationString string) (OutputGame, []OutputGameStep, error)

// Coming soon
ConvertNotation(game InputGame, notationString string, toNotation string) (OutputGame, []OutputGameStep, error)
```

## Server example
Expand Down Expand Up @@ -78,3 +86,7 @@ func main() {
♙♙♙♙♙♙♙♙
♖♘♗♕♔♗♘♖
```

## Why is it called "cheesse"?

That's roughly how kiwi people pronounce chess.

0 comments on commit d2f220c

Please sign in to comment.