Permalink
Browse files

notes

  • Loading branch information...
1 parent c0fb1df commit 129d42f5b1f9bdf900a7be73521db14973a3ace6 @eed3si9n committed Aug 1, 2016
Showing with 21 additions and 0 deletions.
  1. +6 −0 README.md
  2. +14 −0 notes/0.1.0.markdown
  3. +1 −0 notes/about.markdown
View
@@ -3,6 +3,12 @@ gigahorse-github
gigahorse-github is a Gigahorse plugin for github API v3.
+## setup
+
+```scala
+libraryDependencies += "com.eed3si9n" %% "gigahorse-github" % "gigahorse0.1.1_0.1.0"
+```
+
## authentication
you can choose one from the four authenticating clients:
View
@@ -0,0 +1,14 @@
+This is the initial release of gigahorse-github, a Gigahorse plugin for Github API v3.
+
+Here’s a quick example of how to get repository info:
+
+ scala> import gigahorse._, gigahorse.github.Github, scala.concurrent._, duration._
+
+ scala> val client = Github.localConfigClient
+ client: gigahorse.github.LocalConfigClient = LocalConfigClient(OAuthClient(****, List(StringMediaType(application/json), GithubMediaType(Some(v3),None,Some(json)))))
+
+ scala> Gigahorse.withHttp { http =>
+ val f = http.run(client(Github.repo("eed3si9n", "gigahorse-github")), Github.asRepo)
+ Await.result(f, 2.minutes)
+ }
+ res0: gigahorse.github.response.Repo = Repo(https://api.github.com/repos/eed3si9n/gigahorse-github, gigahorse-github, 64614221, User(https://api.github.com/users/eed3si9n, eed3si9n, 184683, Some(https://github.com/eed3si9n), Some(https://avatars.githubusercontent.com/u/184683?v=3), Some(), Some(User), Some(true), None, None), eed3si9n/gigahorse-github, Some(Gigahorse plugin for Github API v3),...
@@ -0,0 +1 @@
+[gigahorse-github](https://github.com/eed3si9n/gigahorse-github) is a Gigahorse plugin for Github API v3.

0 comments on commit 129d42f

Please sign in to comment.