From ba723826acbac7cd60caa170de4b0512fbe4412f Mon Sep 17 00:00:00 2001 From: Jakub Kadlcik Date: Sun, 29 Dec 2024 11:52:06 +0100 Subject: [PATCH] Improve README --- README.md | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 07f44c7..3bb14b6 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,12 @@ # Crooked Rook -[![Package Version](https://img.shields.io/hexpm/v/crooked_rook)](https://hex.pm/packages/crooked_rook) -[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/crooked_rook/) +All information about the project are in this blog post +- -```sh -gleam add crooked_rook@1 -``` -```gleam -import crooked_rook +See this two-minute video. + +[![Demo](https://i1.ytimg.com/vi/HAxBOoBoVTM/maxresdefault.jpg)](https://www.youtube.com/watch?v=HAxBOoBoVTM) -pub fn main() { - // TODO: An example of the project in use -} -``` ## Dependencies @@ -22,15 +16,8 @@ cargo install intiface-engine ~/.cargo/bin/intiface-engine --websocket-port 12345 --use-bluetooth-le ``` - Further documentation can be found at . -## Development - -```sh -gleam run # Run the project -gleam test # Run the tests -``` ## See also