README.md

What is this?

As the project name suggests it's a SDK for GitHub and it's written for Android(/Java). It's built on Retrofit, Auto Value, RxJava and Moshi.

How do I get it?

Import it with Gradle like this:

compile 'com.github.meisolsson:githubsdk:0.5.1'

How do I use it?

Firstly we init JodaTimeAndroid

    JodaTimeAndroid.init(this);

Next we get a token and add it to the TokenStore

    ServiceGenerator.createAuthService()
            .getToken(request)
            .subscribe(new SingleObserver<GitHubToken>() {
                @Override
                public void onSubscribe(Disposable d) {
                }

                @Override
                public void onSuccess(GitHubToken token) {
                    if (token.accessToken() != null) {
                        TokenStore.getInstance(context).saveToken(token);
                    } else if (token.error() != null) {
                        //TODO: Handle error
                    }
                }

                @Override
                public void onError(Throwable e) {
                    //TODO: Handle error
                }
            });

After saving the token we can start fetching data! (This gets the currently authenticated user)

    Single<User> single = ServiceGenerator.createService(context, UserService.class).getUser();