Packages

captain_hook_client

0.1.0
0.1.0 retired

CaptainHook client

Retired package: Renamed - captain_hook_signature
HexDocs

Current section

Files

Jump to
Readme
1 Version
2 Dependencies
0 Dependants
Files
Activity
captain_hook_client README.md
Raw

README.md 

# CaptainHookClient



[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/annatel/captain_hook_client/CI?cacheSeconds=3600&style=flat-square)](https://github.com/annatel/captain_hook_client/actions) [![GitHub issues](https://img.shields.io/github/issues-raw/annatel/captain_hook_client?style=flat-square&cacheSeconds=3600)](https://github.com/annatel/captain_hook_client/issues) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?cacheSeconds=3600?style=flat-square)](http://opensource.org/licenses/MIT) [![Hex.pm](https://img.shields.io/hexpm/v/captain_hook_client?style=flat-square)](https://hex.pm/packages/captain_hook_client) [![Hex.pm](https://img.shields.io/hexpm/dt/captain_hook_client?style=flat-square)](https://hex.pm/packages/captain_hook_client)



[`CaptainHook`](https://github.com/annatel/captain_hook) client verifies the request body in order to ensure that its signature is valid.



The code is based on [bytepack](https://github.com/dashbitco/bytepack_archive) from dashbitco since [`CaptainHook`](https://github.com/annatel/captain_hook) use the same mechanism to sign its requests.



## Installation



The package can be installed by adding `captain_hook_client` to your list of dependencies in `mix.exs`:



```elixir

def deps do

  [

    {:captain_hook_client, "~> 0.1.0"}

  ]

end

```



The docs can be found at [https://hexdocs.pm/captain_hook_client](https://hexdocs.pm/captain_hook_client).