Skip to content

Commit 0a794b8

Browse files
committed
Installation, Usage for readme
1 parent 4bbd20e commit 0a794b8

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,23 @@
11
# GitHubAPI
22
Github API for InterSystems Caché
3+
4+
## Installation
5+
6+
Import xmls into any namespace and compile.
7+
8+
## Usage
9+
10+
First create api object to interact with GitHub API (provide valid GitHub user and pass):
11+
12+
`Set api = ##class(GitHub.API).%New("user","pass")`
13+
14+
After that you can query some GitHub APIs. For example to get info about all public repos in organization:
15+
16+
`Do api.GetOrgRepos("intersystems-ru","public",.repos)`
17+
18+
All availible API calls are listed in class documentation of `GitHub.API` class.
19+
20+
Some workflows to automate work with GitHub are availible in `GitHub.Workflows` class.
21+
22+
## Some API method I want is not availible. What do I do?
23+
Everyone is welcome to add methods or wokflows via pull requests.

0 commit comments

Comments
 (0)