1
1
<div align =" center " >
2
2
3
- # Fields
3
+ # ` fields `
4
4
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
7
7
[ 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 />
14
15
15
16
<!--
16
17
TODO: update intro copy once we ship better docs!
@@ -19,7 +20,7 @@ with built-in validation, testing, sanitising and encryption.
19
20
See below for examples!
20
21
-->
21
22
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 )
23
24
[ ![ codecov.io] ( https://img.shields.io/codecov/c/github/dwyl/fields/master.svg?style=flat-square )] ( https://codecov.io/github/dwyl/fields?branch=master )
24
25
[ ![ Hex.pm] ( https://img.shields.io/hexpm/v/fields?color=brightgreen&style=flat-square )] ( https://hex.pm/packages/fields )
25
26
[ ![ 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 />
39
40
We wanted a ** _ much_ easier/faster** way of building apps
40
41
so we created a collection of pre-defined fields
41
42
with built-in validation, sanitising and security.
42
- ** ` Fields ` ** makes defining Ecto Schemas faster
43
+ ** ` Fields ` ** makes defining ` Ecto ` Schemas faster
43
44
and more precise.
44
45
45
46
# _ What_ ? 💭
@@ -125,7 +126,7 @@ schema "users" do
125
126
field :email , Fields .EmailEncrypted # Validates email then encrypts
126
127
field :address , Fields .AddressEncrypted # Trims address string then encrypts
127
128
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
129
130
130
131
timestamps ()
131
132
end
0 commit comments