Skip to content

Commit 497f391

Browse files
committed
docs: update README
1 parent 7e329a4 commit 497f391

1 file changed

Lines changed: 5 additions & 11 deletions

File tree

README.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,6 @@
11
# Knigge
22

3-
[![CI](https://github.com/alexocode/knigge/workflows/CI/badge.svg)](https://github.com/alexocode/knigge/actions?query=branch%3Amain+workflow%3ACI)
4-
[![Coverage Status](https://coveralls.io/repos/github/alexocode/knigge/badge.svg?branch=main)](https://coveralls.io/github/alexocode/knigge?branch=main)
5-
[![Hexdocs.pm](https://img.shields.io/badge/hexdocs-online-blue)](https://hexdocs.pm/knigge/)
6-
[![Hex.pm](https://img.shields.io/hexpm/v/knigge.svg)](https://hex.pm/packages/knigge)
7-
[![Hex.pm Downloads](https://img.shields.io/hexpm/dt/knigge)](https://hex.pm/packages/knigge)
8-
[![Featured - ElixirRadar](https://img.shields.io/badge/featured-ElixirRadar-543A56)](https://app.rdstation.com.br/mail/0ddee1c8-2ce9-405b-b95f-09c883099090?utm_campaign=elixir_radar_202&utm_medium=email&utm_source=RD+Station)
9-
[![Featured - ElixirWeekly](https://img.shields.io/badge/featured-ElixirWeekly-875DB0)](https://elixirweekly.net/issues/161)
3+
Forked from https://github.com/alexocode/knigge.
104

115
An opinionated way of dealing with behaviours.
126

@@ -17,7 +11,7 @@ is either given directly to `Knigge` or fetched from the configuration.
1711
`Knigge` can be `use`d directly in a behaviour, or in a separate module by
1812
passing the behaviour which should be "facaded" as an option.
1913

20-
[See the documentation](https://hexdocs.pm/knigge) for more information.
14+
[See the documentation](https://hexdocs.pm/ex_knigge) for more information.
2115

2216
## Table of Contents
2317

@@ -44,7 +38,7 @@ Simply add `knigge` to your list of dependencies in your `mix.exs`:
4438
```elixir
4539
def deps do
4640
[
47-
{:ex_knigge, "~> 1.4"}
41+
{:ex_knigge, "2.0.0-rc.0"}
4842
]
4943
end
5044
```
@@ -241,12 +235,12 @@ since the implementing module will have to be loaded for each call.
241235
If you want to do delegation at runtime simply pass `delegate_at_runtime?: true`
242236
as option - by default `Knigge` delegates at runtime in your `:test`s.
243237
244-
For further information about options check the [`Knigge.Options` module](https://hexdocs.pm/knigge/Knigge.Options.html).
238+
For further information about options check the [`Knigge.Options` module](https://hexdocs.pm/ex_knigge/Knigge.Options.html).
245239
246240
## Verifying your implementations - `mix knigge.verify`
247241
248242
Before version 1.2.0 `Knigge` tried to check at compile time if the implementation of your facade existed.
249-
Due to the way the Elixir compiler goes about compiling your modules this didn't work as expected - [checkout this page if you're interested in the details](https://hexdocs.pm/knigge/the-existence-check.html).
243+
Due to the way the Elixir compiler goes about compiling your modules this didn't work as expected - [checkout this page if you're interested in the details](https://hexdocs.pm/ex_knigge/the-existence-check.html).
250244
251245
As an alternative `Knigge` now offers the `mix knigge.verify` task which verifies that the implementation modules of your facades actually exist.
252246
The task returns with an error code when an implementation is missing, which allows you to plug it into your CI pipeline - for example as `MIX_ENV=prod mix knigge.verify`.

0 commit comments

Comments
 (0)