Page MenuHomePhorge
Files F115240

No OneTemporary
Actions

Size
1 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/README.md b/README.md
index 907565f..de7c8fc 100644
--- a/README.md
+++ b/README.md
@@ -1,56 +1,47 @@
# 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`:
```elixir
def deps do
[{:linkify, "~> 0.1"}]
end
```
## Usage
The following examples illustrate some examples on how to use the auto linker.
```elixir
iex> Linkify.link("google.com")
"<a href=\"http://google.com\">google.com</a>"
iex> Linkify.link("google.com", class: "linkified")
"<a href=\"http://google.com\" class=\"linkified\">google.com</a>"
iex> Linkify.link("google.com", new_window: true)
"<a href=\"http://google.com\" target=\"_blank\">google.com</a>"
iex> Linkify.link("google.com", new_window: true, rel: "noopener noreferrer")
"<a href=\"http://google.com\" target=\"_blank\" rel=\"noopener noreferrer\">google.com</a>"
```
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]
```
## License
`auto_linker` is Copyright (c) 2017 E-MetroTel
The source is released under the MIT License.
Check [LICENSE](LICENSE) for more information.

File Metadata

Mime Type
text/x-diff
Expires
Wed, Nov 27, 3:47 PM (1 d, 19 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
40683
Default Alt Text
(1 KB)

Event Timeline