Page Menu
Home
Phorge
Search
Configure Global Search
Log In
Files
F140783
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Award Token
Flag For Later
Size
1 KB
Referenced Files
None
Subscribers
None
View Options
diff --git a/README.md b/README.md
index e1b6d5e..1331a3e 100644
--- a/README.md
+++ b/README.md
@@ -1,20 +1,28 @@
# HttpSignatures
**Elixir library for manipulating and validating HTTP signatures.**
## Installation
-If [available in Hex](https://hex.pm/docs/publish), the package can be installed
-by adding `http_signatures` to your list of dependencies in `mix.exs`:
+The package can be installed by adding `http_signatures` to your list
+of dependencies in `mix.exs`:
```elixir
def deps do
[
{:http_signatures, "~> 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/http_signatures](https://hexdocs.pm/http_signatures).
+You will need to write an adapter module that compiles with the
+`HTTPSignatures.Adapter` behaviour. This is used to fetch the public
+keys when verifying signatures. The adapter is configured like so:
+
+```
+config :http_signatures, adapter: YourAdapter
+```
+
+## Documentation
+
+Published at [https://hexdocs.pm/http_signatures](https://hexdocs.pm/http_signatures).
File Metadata
Details
Attached
Mime Type
text/x-diff
Expires
Tue, Jan 21, 3:26 PM (1 d, 7 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
55726
Default Alt Text
(1 KB)
Attached To
Mode
R18 http_signatures
Attached
Detach File
Event Timeline
Log In to Comment