diff --git a/.gitignore b/.gitignore index 28fe113..36542ef 100644 --- a/.gitignore +++ b/.gitignore @@ -28,5 +28,4 @@ shortcut_api_ex-*.tar .env .envrc -man/ .DS_Store \ No newline at end of file diff --git a/man/basics/getting-started.md b/man/basics/getting-started.md new file mode 100644 index 0000000..f096226 --- /dev/null +++ b/man/basics/getting-started.md @@ -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) +``` \ No newline at end of file diff --git a/mix.exs b/mix.exs index 4131ef8..47f6b4b 100644 --- a/mix.exs +++ b/mix.exs @@ -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: [