diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ad6a99 --- /dev/null +++ b/README.md @@ -0,0 +1,11 @@ +# breadboard-client + +[![GitHub](https://img.shields.io/badge/GitHub-181717?logo=github&logoColor=white)](https://github.com/ExaDev/breadboard-client) [![npm](https://img.shields.io/badge/npm-CB3837?logo=npm&logoColor=white)](https://www.npmjs.com/package/@exadev/breadboard-client) [![Release](https://img.shields.io/github/v/release/ExaDev/breadboard-client)](https://github.com/ExaDev/breadboard-client/releases/latest) [![CI](https://img.shields.io/github/actions/workflow/status/ExaDev/breadboard-client/ci.yml?branch=main)](https://github.com/ExaDev/breadboard-client/actions) + +TypeScript client library for the Breadboard API, for listing, describing and running boards and streaming their run events. + +## Installation + +```sh +npm install @exadev/breadboard-client +```