release
dev

unfurl

This library implements "URL unfurling" approximately according to how Slack does it. See this blog post for more info.

Installation

unfurl is available as a Maven artifact from Clojars.

Trying it Out

Clojure CLI

$ clj -Sdeps '{:deps {com.github.pmonks/unfurl {:mvn/version "RELEASE"}}}'

Leiningen

$ lein try com.github.pmonks/unfurl

deps-try

$ deps-try com.github.pmonks/unfurl

Usage

The functionality is provided by the unfurl.api namespace.

Require it in the REPL:

(require '[unfurl.api :as uf] :reload-all)

Require it in your application:

(ns my-app.core
  (:require [unfurl.api :as uf]))

The library provides a single function - unfurl. The API documentation has full details, and the unit tests provide some example usages.

Contributor Information

Contributing Guidelines

Bug Tracker

Code of Conduct

Developer Workflow

This project uses the git-flow branching strategy, with the caveat that the permanent branches are called release and dev. Any changes to the release branch are considered a release and auto-deployed (JARs to Clojars, API docs to GitHub Pages, etc.).

For this reason, all development must occur either in branch dev, or (preferably) in temporary branches off of dev. All PRs from forked repos must also be submitted against dev; the release branch is only updated from dev via PRs created by the core development team. All other changes submitted to release will be rejected.

Why are there so many different groupIds on Clojars for this project?

The project was originally developed under my personal GitHub account. In early 2018 it was transferred to the clj-commons GitHub organisation, but then, as that group refined their scope and mission, it was determined that it no longer belonged there, and the project were transferred back in late 2021. During this time the build tooling for the project also changed from Leiningen to tools.build, which created further groupId churn (tools.build introduced special, useful semantics for com.github.username groupIds that don't exist with Leiningen or Clojars).

License

Copyright © 2016 Peter Monks

Distributed under the Mozilla Public License, version 2.0.

SPDX-License-Identifier: MPL-2.0