Skip to content

Commit 9976f06

Browse files
committed
Reflect more generic purpose of the API client along with repo rename
1 parent 76341b9 commit 9976f06

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

ReadMe.md

+11-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
# GitHub GraphQL Client #
1+
# GitHub API and GraphQL Client #
22

3-
This package provides a GitHub GraphQL API client, automatically handling:
3+
This package provides a generic GitHub API client (`GithubApiClient`) as well as `Codable`-like GitHub GraphQL querying and decoding based on an object's properties.
4+
5+
These two targets automatically handle:
46
- [Authenticating as a GitHub App](https://docs.github.com/en/developers/apps/building-github-apps/authenticating-with-github-apps#authenticating-as-a-github-app)
57
- Building GraphQL queries from Swift objects
68
- Decoding Swift objects from GraphQL responses
@@ -18,6 +20,13 @@ Using this tree, the actual GraphQL query string can be automatically generated,
1820
GraphQL functionality is currently designed only for GitHub's GraphQL API and may not function correctly with any other GraphQL server.
1921
Additionally, this is still in **extremely early development** and may not yet support even all GitHub GraphQL querying operations.
2022

23+
The GitHub API client has explicit helper methods for a limited subset of the full API, currently including:
24+
- Basic app authentication
25+
- GraphQL queries
26+
- Posting issue comments and reactions
27+
28+
However, any arbitrary API call may be made, with authentication automatically injected.
29+
2130

2231
## Quick Start ##
2332

0 commit comments

Comments
 (0)