sam/linkify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
Egor Kislitsyn 2019-06-27 15:32:29 +07:00
parent 66f5165655
commit a26dcdff36
1 changed files with 1 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -1,11 +1,9 @@
# Linkify
Linkify is a basic package for turning website names, and phone numbers into links.
Linkify is a basic package for turning website names into links.
Use this package in your web view to convert web references into click-able links.
This is a very early version. Some of the described options are not yet functional.
## Installation
The package can be installed by adding `linkify` to your list of dependencies in `mix.exs`:
@ -37,13 +35,6 @@ iex> Linkify.link("google.com", new_window: true, rel: "noopener noreferrer")
See the [Docs](https://hexdocs.pm/linkify/) for more examples
## Configuration
By default, link parsing is enabled and phone parsing is disabled.
```elixir
# enable phone parsing, and disable link parsing
config :linkify, opts: [phone: true, url: false]
```