Skip to content

Commit 517d9d6

Browse files
author
Adrián Quintás
committed
Update README
1 parent 3d6a2d4 commit 517d9d6

File tree

2 files changed

+8
-27
lines changed

2 files changed

+8
-27
lines changed

README.md

Lines changed: 7 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,28 @@
1-
# JwtTestUtils
2-
31
[![Coverage Status](https://coveralls.io/repos/github/heyorbit/elixir-jwt-utils/badge.svg?branch=master)](https://coveralls.io/github/heyorbit/elixir-jwt-utils?branch=master)
4-
[![Hex version](https://img.shields.io/hexpm/v/sippet.svg "Hex version")](https://hex.pm/packages/server_utils)
5-
[![Hex Docs](https://img.shields.io/badge/hex-docs-9768d1.svg)](https://hexdocs.pm/server_utils)
2+
[![Hex version](https://img.shields.io/hexpm/v/sippet.svg "Hex version")](https://hex.pm/packages/jwt_test_utils)
3+
[![Hex Docs](https://img.shields.io/badge/hex-docs-9768d1.svg)](https://hexdocs.pm/jwt_test_utils)
64
[![Build Status](https://travis-ci.org/heyorbit/elixir-jwt-utils.svg?branch=master)](https://travis-ci.org/heyorbit/elixir-jwt-utils)
75
[![Deps Status](https://beta.hexfaktor.org/badge/all/github/heyorbit/elixir-jwt-utils.svg)](https://beta.hexfaktor.org/github/heyorbit/elixir-jwt-utils)
86

9-
# ServerUtils
7+
# JwtTestUtils
108

11-
This project has several module utils to handle common tasks in a server, like authorization params parsing.
9+
Test utils for app based JWT authentication
1210

1311
Features:
1412

15-
* Phoenix plug to validate JWT header
16-
* Phoenix plug to parse a pagination request
17-
* Simple integer parsing
18-
* Page query params parser
19-
* JWT claims parser
20-
* Wrapped Logger with Sentry integration
13+
* Create mocked JWT tokens
14+
* Create Plug.Conn structs with an injected JWT token
2115

2216
## Installation
2317

2418
Add to dependencies
2519

2620
```elixir
2721
def deps do
28-
[{:server_utils, "~> 0.1.3"}]
22+
[{:jwt_test_utils, "~> 0.1.1", only: :test}]
2923
end
3024
```
3125

3226
```bash
3327
mix deps.get
3428
```
35-
36-
## Configuration
37-
38-
Configure default pagination params
39-
40-
```
41-
config :server_utils,
42-
page_size_key: "page_size",
43-
page_number_key: "page_number",
44-
max_page_size: 25,
45-
page_size: 10,
46-
page_number: 1
47-
```

mix.exs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ defmodule JwtTestUtils.MixProject do
44
def project do
55
[
66
app: :jwt_test_utils,
7-
version: "0.1.0",
7+
version: "0.1.1",
88
elixir: "~> 1.6",
99
start_permanent: Mix.env() == :prod,
1010
aliases: aliases(),

0 commit comments

Comments
 (0)