Skip to content

Commit 3afccaa

Browse files
committed
fix broken build badge in README.md #116
1 parent e94d764 commit 3afccaa

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,17 @@
11
<div align="center">
22

3-
# Fields
3+
# `fields`
44

5-
A **collection of frequently used fields** implemented as custom **`Ecto` types** <br />
6-
with
5+
A **collection of frequently used `fields`** implemented as custom **`Ecto` Types** <br />
6+
with best-practice following
77
[validation](https://hexdocs.pm/fields/Fields.Validate.html),
8-
[sanitising](https://hexdocs.pm/fields/Fields.HtmlBody.html)
9-
and
10-
[encryption](https://hexdocs.pm/fields/Fields.AES.html)
11-
/
12-
[hashing](https://hexdocs.pm/fields/Fields.Password.html)
13-
to **build `Phoenix` Apps _much_ faster!** 🚀<br />
8+
[sanitising](https://hexdocs.pm/fields/Fields.HtmlBody.html),
9+
transparent
10+
[encryption](https://hexdocs.pm/fields/Fields.AES.html) /
11+
[decryption](https://hexdocs.pm/fields/Fields.AES.html#decrypt/1)
12+
&
13+
[hashing](https://hexdocs.pm/fields/Fields.Password.html) functions<br />
14+
to **build Privacy Compliant & Security-focussed `Phoenix` Apps _much_ faster!** 🚀<br />
1415

1516
<!--
1617
TODO: update intro copy once we ship better docs!
@@ -19,7 +20,7 @@ with built-in validation, testing, sanitising and encryption.
1920
See below for examples!
2021
-->
2122

22-
![GitHub Workflow Status](https://img.shields.io/github/workflow/status/dwyl/fields/Elixir%20CI?label=build&style=flat-square)
23+
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/dwyl/fields/ci.yml?label=build&style=flat-square&branch=main)
2324
[![codecov.io](https://img.shields.io/codecov/c/github/dwyl/fields/master.svg?style=flat-square)](https://codecov.io/github/dwyl/fields?branch=master)
2425
[![Hex.pm](https://img.shields.io/hexpm/v/fields?color=brightgreen&style=flat-square)](https://hex.pm/packages/fields)
2526
[![docs](https://img.shields.io/badge/docs-maintained-brightgreen?style=flat-square)](https://hexdocs.pm/fields/api-reference.html)
@@ -39,7 +40,7 @@ for commonly used fields on each new **`Phoenix`** project/App ... <br />
3940
We wanted a **_much_ easier/faster** way of building apps
4041
so we created a collection of pre-defined fields
4142
with built-in validation, sanitising and security.
42-
**`Fields`** makes defining Ecto Schemas faster
43+
**`Fields`** makes defining `Ecto` Schemas faster
4344
and more precise.
4445

4546
# _What_? 💭
@@ -125,7 +126,7 @@ schema "users" do
125126
field :email, Fields.EmailEncrypted # Validates email then encrypts
126127
field :address, Fields.AddressEncrypted # Trims address string then encrypts
127128
field :postcode, Fields.PostcodeEncrypted # Validates postcode then encrypts
128-
field :password, Fields.Password # Hash password with argon2
129+
field :password, Fields.Password # Hash password with argon2 industry standard
129130

130131
timestamps()
131132
end

0 commit comments

Comments
 (0)