From 7ab396bdd099e49733c3effc5296e9488fad4558 Mon Sep 17 00:00:00 2001 From: Michael Edoror Date: Wed, 27 Nov 2024 10:10:33 -0600 Subject: [PATCH] Update README.md --- README.md | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 8a91de3..9a2b0c7 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,14 @@ -# ShortcutApiEx +# shortcut_api_ex +[![Hex.pm](https://img.shields.io/hexpm/v/shortcut_api_ex.svg)](https://hex.pm/packages/shortcut_api_ex) +[![Docs](https://img.shields.io/badge/hex-docs-blue.svg)](https://hexdocs.pm/shortcut_api_ex) +[![CI](https://github.com/mechanical-orchard/shortcut_api_ex/actions/workflows/ci.yml/badge.svg)](https://github.com/mechanical-orchard/shortcut_api_ex/actions/workflows/ci.yml) +[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) -Elixir client for the [Shortcut](https://www.shortcut.com/) API. - -[API Docs](https://developer.shortcut.com/api/rest/v3) +Elixir client for the [Shortcut API](https://developer.shortcut.com/api/rest/v3) ## Installation -If [available in Hex](https://hex.pm/docs/publish), the package can be installed +To install shortcut_api_ex, add it to your mix.exs file: by adding `shortcut_api_ex` to your list of dependencies in `mix.exs`: ```elixir @@ -17,6 +19,7 @@ def deps do end ``` -Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc) -and published on [HexDocs](https://hexdocs.pm). Once published, the docs can -be found at . +Then run: +```elixir +mix deps.get +```