Packages

An API client for Caddy's browse directory listings

Current section

Files

Jump to
caddy_browse README.md
Raw

README.md

# caddy_browse
An API client for Caddy's browse directory listings
[![Package Version](https://img.shields.io/hexpm/v/caddy_browse)](https://hex.pm/packages/caddy_browse)
[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://caddy-browse.hexdocs.pm/)
```sh
gleam add caddy_browse@1
```
```gleam
import caddy_browse
import gleam/http/request
pub fn main() {
// Prepare a HTTP request to a directory served by a Caddy server
// that has browse enabled
let assert Ok(request) = request.to("https://example.com/some/path")
let request = caddy_browse.request(request)
// Send it with your HTTP client
let assert Ok(response) = your_http_client.send(request)
// Parse that to get the directory listing
caddy_browse.response(response)
}
```
Further documentation can be found at <https://caddy-browse.hexdocs.pm/>.