Page MenuHomePhorge
Files F115647

No OneTemporary
Actions

Size
2 KB
Referenced Files
None
Subscribers
None

View Options

diff --git a/README.md b/README.md
index 253229e..c1b1dcd 100644
--- a/README.md
+++ b/README.md
@@ -1,69 +1,71 @@
# AutoLinker
[![Build Status](https://travis-ci.org/smpallen99/auto_linker.png?branch=master)](https://travis-ci.org/smpallen99/auto_linker) [![Hex Version][hex-img]][hex] [![License][license-img]][license]
[hex-img]: https://img.shields.io/hexpm/v/auto_linker.svg
[hex]: https://hex.pm/packages/auto_linker
[license-img]: http://img.shields.io/badge/license-MIT-brightgreen.svg
[license]: http://opensource.org/licenses/MIT
AutoLinker is a basic package for turning website names, and phone numbers 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 `auto_linker` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:auto_linker, "~> 0.2"}]
end
```
## Usage
The following examples illustrate some examples on how to use the auto linker.
+```iex
iex> AutoLinker.link("google.com")
"<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>google.com</a>"
iex> AutoLinker.link("google.com", new_window: false, rel: false)
"<a href='http://google.com' class='auto-linker'>google.com</a>"
iex> AutoLinker.link("google.com", new_window: false, rel: false, class: false)
"<a href='http://google.com'>google.com</a>"
-iex> AutoLinker.link("call me at x9999")
-~s{call me at <a href="" class="phone-number" data-number="9999">x9999</a>}
+iex> AutoLinker.link("call me at x9999", phone: true)
+"call me at <a href=\"#\" class=\"phone-number\" data-phone=\"9999\">x9999</a>"
-iex> AutoLinker.link("or at home on 555.555.5555")
-~s{or at home on <a href="" class="phone-number" data-number="55555555555">555.555.5555</a>}
+iex> AutoLinker.link("or at home on 555.555.5555", phone: true)
+"or at home on <a href=\"#\" class=\"phone-number\" data-phone=\"5555555555\">555.555.5555</a>"
-iex> AutoLinker.link(", work (555) 555-5555")
-~s{, work <a href="" class="phone-number" data-number="5555555555">(555) 555-5555</a>}
+iex> AutoLinker.link(", work (555) 555-5555", phone: true)
+", work <a href=\"#\" class=\"phone-number\" data-phone=\"5555555555\">(555) 555-5555</a>"
iex> AutoLinker.link("[Google Search](http://google.com)", markdown: true)
"<a href='http://google.com' class='auto-linker' target='_blank' rel='noopener noreferrer'>Google Search</a>"
+```
See the [Docs](https://hexdocs.pm/auto_linker/) for more examples
## Configuration
By default, link parsing is enabled and phone parsing is disabled.
```elixir
# enable phone parsing, and disable link parsing
config :auto_linker, 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
Thu, Nov 28, 10:21 AM (1 d, 17 h)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
41022
Default Alt Text
(2 KB)

Event Timeline