Skip to content

Commit b17df86

Browse files
committed
Remove out-dated README content.
1 parent d2b4074 commit b17df86

File tree

1 file changed

+1
-34
lines changed

1 file changed

+1
-34
lines changed

README.md

Lines changed: 1 addition & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
# Dialyxir
22

3-
[![Build Status](https://travis-ci.org/jeremyjh/dialyxir.svg?branch=master)](https://travis-ci.org/jeremyjh/dialyxir)
43
[![Module Version](https://img.shields.io/hexpm/v/dialyxir.svg)](https://hex.pm/packages/dialyxir)
54
[![Hex Docs](https://img.shields.io/badge/hex-docs-lightgreen.svg)](https://hexdocs.pm/dialyxir/)
65
[![Total Download](https://img.shields.io/hexpm/dt/dialyxir.svg)](https://hex.pm/packages/dialyxir)
@@ -9,28 +8,16 @@
98

109
Mix tasks to simplify use of Dialyzer in Elixir projects.
1110

12-
## Changes in 1.0
13-
14-
Elixir 1.6 is required, to support the new pretty printing feature. If your
15-
project is not yet on 1.6, continue to specify 0.5 in your mix deps.
16-
17-
Warning messages have been greatly improved, but are filtered through the legacy formatter to support your existing ignore files. You can optionally use the new Elixir [term format](#elixir-term-format) for ignore files. You may want to use the `--format short` argument in your CI pipelines. There are several formats, also there is a new `explain` feature - for details see CLI [options](#command-line-options).
18-
19-
## Quickstart
20-
If you are planning to use Dialyzer with an application built with the [Phoenix Framework](http://www.phoenixframework.org/), check out the [Quickstart wiki](https://github.com/jeremyjh/dialyxir/wiki/Phoenix-Dialyxir-Quickstart).
21-
2211
## Installation
2312

2413
Dialyxir is available on [hex.pm](https://hex.pm/packages/dialyxir).
2514

26-
You can either add it as a dependency in your mix.exs, or install it globally as an archive task.
27-
2815
To add it to a mix project, just add a line like this in your deps function in mix.exs:
2916

3017
```elixir
3118
defp deps do
3219
[
33-
{:dialyxir, "~> 1.0", only: [:dev], runtime: false},
20+
{:dialyxir, "~> 1.3", only: [:dev], runtime: false},
3421
]
3522
end
3623
```
@@ -82,26 +69,6 @@ To use Dialyzer in CI, you must be aware of several things:
8269
2) The PLT should be cached using the CI caching system
8370
3) The PLT will need to be rebuilt whenever adding a new Erlang or Elixir version to build matrix
8471

85-
### Travis
86-
87-
`.travis.yml`
88-
```markdown
89-
language: elixir
90-
91-
elixir:
92-
- 1.8
93-
94-
otp_release:
95-
- 21.0
96-
97-
script:
98-
- mix dialyzer
99-
100-
cache:
101-
directories:
102-
- priv/plts
103-
```
104-
10572
### Github Actions
10673

10774
`dialyzer.yml`

0 commit comments

Comments
 (0)