diff --git a/README.md b/README.md index df78900..e035ac3 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,15 @@ # klä -[![Build Status][travis badge]][travis] [![LFE Versions][lfe badge]][lfe] [![Erlang Versions][erlang badge]][versions] [![Tags][github tags badge]][github tags] [![Downloads][hex downloads]][hex package] - -[![][kla-logo]][kla-logo-large] +[![Build Status][gh-actions-badge]][gh-actions] +[![LFE Versions][lfe badge]][lfe] +[![Erlang Versions][erlang badge]][versions] +[![Tags][github tags badge]][github tags] *An LFE Wrapper Library used to Dress Up Erlang Libraries in a Lispy Costume* +[![Project logo][logo]][logo-large] -##### Contents +##### Table of Contents * [Introduction](#introduction-) * [Dependencies](#dependencies-) @@ -17,8 +19,7 @@ ## Introduction [↟](#contents) -Add content to me here! - +This is a utility library created and used simply for aesthetics. ## Dependencies [↟](#contents) @@ -33,43 +34,34 @@ you may use the most recent rebar2-compatible release of kla: 0.4.2. Just add it to your ``rebar.config`` deps: ```erlang - {deps, [ +{deps, [ ... - {kla, ".*", - {git, "git@github.com:lfex/kla.git", {branch, "master"}}} - ]}. + {kla, "0.9.1"} +]}. ``` And then do the usual: ```bash - $ rebar get-deps $ rebar compile ``` - ## Usage [↟](#contents) Add content to me here! +[//]: ---Named-Links--- - - - -[kla-logo]: priv/images/vikings-small.png -[kla-logo-large]: http://callego.deviantart.com/art/Viking-Clothes-334955145 +[logo]: priv/images/vikings-small.png +[logo-large]: http://callego.deviantart.com/art/Viking-Clothes-334955145 [github]: https://github.com/lfex/kla [gitlab]: https://gitlab.com/lfex/kla -[travis]: https://travis-ci.org/lfex/kla -[travis badge]: https://img.shields.io/travis/lfex/kla.svg -[lfe]: https://github.com/rvirding/lfe +[gh-actions-badge]: https://github.com/lfex/kla/workflows/ci%2Fcd/badge.svg +[gh-actions]: https://github.com/lfex/kla/actions +[lfe]: https://github.com/lfe/lfe [lfe badge]: https://img.shields.io/badge/lfe-1.3.0-blue.svg -[erlang badge]: https://img.shields.io/badge/erlang-17.5%20to%2022.0-blue.svg -[versions]: https://github.com/lfex/kla/blob/master/.travis.yml +[erlang badge]: https://img.shields.io/badge/erlang-21%20to%2026-blue.svg +[versions]: https://github.com/lfex/lxml/blob/master/.github/workflows/cicd.yml [github tags]: https://github.com/lfex/kla/tags [github tags badge]: https://img.shields.io/github/tag/lfex/kla.svg -[github downloads]: https://img.shields.io/github/downloads/atom/atom/total.svg -[hex badge]: https://img.shields.io/hexpm/v/kla.svg?maxAge=2592000 -[hex package]: https://hex.pm/packages/kla -[hex downloads]: https://img.shields.io/hexpm/dt/kla.svg