Skip to content

Commit

Permalink
Unignore man dir, add getting-started.md guide
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverswitzer committed Nov 26, 2024
1 parent eb2a7ed commit e2cff34
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,4 @@ shortcut_api_ex-*.tar
.env
.envrc

man/
.DS_Store
24 changes: 24 additions & 0 deletions man/basics/getting-started.md
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)
```
1 change: 0 additions & 1 deletion mix.exs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ defmodule ShortcutApiEx.MixProject do
main: "readme",
extras: [
"README.md": [title: "Read Me"],
# basics...
"man/basics/getting-started.md": [filename: "basics-getting-started"]
],
groups_for_modules: [
Expand Down

0 comments on commit e2cff34

Please sign in to comment.