james/wayfarer
1
0
Fork 0
Code Issues 3 Pull requests 1 Projects Releases 6 Packages Wiki Activity

docs: Update Readme.
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse source
This commit is contained in:
James Harton 2024-03-06 19:28:10 +13:00
parent ca1a344057
commit 3383898512
Signed by: james
GPG key ID: 90E82DAA13F624F4
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -1,6 +1,6 @@
# Wayfarer
[![Build Status](https://drone.harton.nz/api/badges/james/wayfarer/status.svg?ref=refs/heads/main)](https://drone.harton.nz/james/wayfarer)
[![Build Status](https://drone.harton.dev/api/badges/james/wayfarer/status.svg?ref=refs/heads/main)](https://drone.harton.dev/james/wayfarer)
[![Hippocratic License HL3-FULL](https://img.shields.io/static/v1?label=Hippocratic%20License&message=HL3-FULL&labelColor=5e2751&color=bc8c3d)](https://firstdonoharm.dev/version/3/0/full.html)
Wayfarer is a runtime-configurable HTTP reverse proxy using
@ -13,23 +13,25 @@ Wayfarer is yet to handle it's first HTTP request. Please hold.
## Installation
Wayfarer is not yet available on Hex, so you will need to add it as a Git
dependency in your app:
Wayfarer is [available in Hex](https://hex.pm/packages/wayfarer), the package
can be installed by adding `wayfarer` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:wayfarer, git: "https://harton.dev/james/wayfarer.git", tag: "v0.1.0"}
{:wayfarer, "~> 0.4.0"}
]
end
```
Documentation for `main` is always available on [my docs site](https://docs.harton.nz/james/wayfarer/Wayfarer.html).
Documentation for the latest release can be found on
[HexDocs](https://hexdocs.pm/wayfarer) and for the `main` branch on
[docs.harton.nz](https://docs.harton.nz/james/wayfarer).
## Github Mirror
This repository is mirrored [on Github](https://github.com/jimsynz/angle)
from it's primary location [on my Forejo instance](https://harton.dev/james/angle).
This repository is mirrored [on Github](https://github.com/jimsynz/wayfarer)
from it's primary location [on my Forejo instance](https://harton.dev/james/wayfarer).
Feel free to raise issues and open PRs on Github.
## License