# circuit

<div align="center">

<img src="/public/g55.svg" alt="circuit logo" height="180" />

<br/>

**Prevent cascading failures in your Gleam applications. Circuit breaker pattern with sliding window tracking, OTP-supervised state, and support for both Erlang and JavaScript targets.**

<br/>

[![Package Version](https://img.shields.io/hexpm/v/circuit?style=flat-square&color=ffaff3&labelColor=1a1a2e)](https://hex.pm/packages/circuit)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3?style=flat-square&labelColor=1a1a2e)](https://hexdocs.pm/circuit/)
[![License](https://img.shields.io/badge/license-MIT-a8d8a8?style=flat-square&labelColor=1a1a2e)](LICENSE)

</div>

---

## Installation

Add `circuit` to your Gleam project:

```sh
gleam add circuit@1
```

## Quick Start

```gleam
import circuit

pub fn main() -> Nil {
  // TODO: An example of the project in use
}
```

> 📖 Full documentation is available at [hexdocs.pm/circuit](https://hexdocs.pm/circuit).

---

## Development

Clone the repo and use the standard Gleam commands:

```sh
gleam run   # Run the project
gleam test  # Run the tests
```

---

<div align="center">

Made with ♥ using [Gleam](https://gleam.run)

</div>