-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Unignore man dir, add getting-started.md guide
- Loading branch information
1 parent
eb2a7ed
commit e2cff34
Showing
3 changed files
with
24 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,5 +28,4 @@ shortcut_api_ex-*.tar | |
.env | ||
.envrc | ||
|
||
man/ | ||
.DS_Store |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
# Getting Started | ||
|
||
This guide will help you get up and running with the `shortcut_api_ex` library. | ||
|
||
## Prerequisites | ||
|
||
Before you begin, make sure you have the following: | ||
|
||
- Elixir installed (version 1.16 or later) | ||
- A Shortcut API token (you can get one from the [Shortcut app settings](https://app.shortcut.com/mechanical-orchard/settings/account/api-tokens)) | ||
|
||
## Installation | ||
|
||
Add `shortcut_api_ex` to your list of dependencies in `mix.exs`: | ||
|
||
## Example | ||
|
||
You can use the `ShortcutApiEx.Epics.list_epics/1` function to fetch a list of epics from the Shortcut API. Here's an example: | ||
|
||
elixir | ||
``` | ||
token = "your_shortcut_api_token" | ||
{:ok, epics} = ShortcutApiEx.Epics.list_epics(token) | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters