https://github.com/probably-not/pilot
A connection adapter for the Starship webserver. Every Starship needs a Pilot.
https://github.com/probably-not/pilot
Last synced: 2 months ago
JSON representation
A connection adapter for the Starship webserver. Every Starship needs a Pilot.
- Host: GitHub
- URL: https://github.com/probably-not/pilot
- Owner: probably-not
- License: mit
- Created: 2019-06-30T04:15:58.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-04-18T20:26:42.000Z (over 5 years ago)
- Last Synced: 2025-01-07T06:32:14.074Z (over 1 year ago)
- Language: Elixir
- Size: 15.6 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Pilot
A connection adapter for the [**Starship**](https://github.com/probably-not/starship) webserver, similar to how Plug works with Cowboy.
The original idea was to build an adapter for Plug (à la `plug_cowboy`). However there isn't any documentation for building adapters and looking through the `plug_cowboy` package wasn't helping as I couldn't find a behaviour for the adapter, so I decided to build my own package.
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `pilot` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:pilot, "~> 0.1.0"}
]
end
```
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/pilot](https://hexdocs.pm/pilot).