# shcribe

This is a library that dumps HTTP requests and responses to markdown files.

The idea is to add this to your test suite to document real request/response
examples semi-automatically.

[![Package Version](https://img.shields.io/hexpm/v/shcribe)](https://hex.pm/packages/shcribe)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/shcribe/)

```sh
gleam add shcribe@1
```
```gleam
import shcribe

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

Further documentation can be found at <https://hexdocs.pm/shcribe>.

## Development

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