Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
medoror-mo committed Nov 27, 2024
1 parent 70431e3 commit 7ab396b
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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 <https://hexdocs.pm/shortcut_api_ex>.
Then run:
```elixir
mix deps.get
```

0 comments on commit 7ab396b

Please sign in to comment.