<div align="center">

# `link`

🔗 Parse, shorten and format links. 

![GitHub Workflow Status](
[![ dependency status](](
[![contributions welcome](](


# Why? 🤷‍♀️

We didn't find a link parsing library 
that did _exactly_ what we needed
so we wrote one. 

# What? 

A micro library for parsing and formatting links
for use in our 
(currently in the 

> **Note**: the code is _deliberately_ "basic".
> not at all "fancy" 
> that is intentional so that it's _understandable_ 
> by a _complete_ beginner to `Elixir`. 🔰
> Simple `code` is _maintainable_ and _extensible_ 
> without having to waste time Googling to figure it out.
> That said, if you want to help refactoring for performance,
> please 
> [open an issue](

# Who? 👤

This library was created _for us by us_,
the `people` using the `@dwyl App`. <br />
We don't expect this to be used by anyone `else`
because it's _probably_ too specific to our use case.
But if you need to parse links (`URLs`) in your project
it _might_ be link ...
If you need a _specific_ feature,
please open an 

# How?

Use this package in your `Elixir` / `Phoenix` App!

## Installation

Add `link` to your list of dependencies 
in your `mix.exs` file:

def deps do
    {:link, "~> 1.0.1"}

Docs can be found at 

## Usage Examples 🔗 

Here are a few examples we use in our `MVP`:

# Compact a GitHub issue URL so it doesn't waste screen space:
> "dwyl/mvp#141"

# Strip the #issuecomment... from a GitHub issue URL:
> "dwyl/mvp#141"

# Shorten the link using Linky (interface TBD)
Link.shorten(conn, "")
> "

# Need _More_? 🙌

If you need a _specific_ function,
[open an issue](
to discuss.