diff --git a/README.md b/README.md index e692780..f85587a 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,105 @@ # Shikikit -Ruby toolkit for the [Shikimori API](https://shikimori.one) +Ruby toolkit for the [Shikimori](https://shikimori.one) [![CI](https://github.com/iwdt/shikikit/actions/workflows/main.yml/badge.svg)](https://github.com/iwdt/shikikit/actions/workflows/main.yml) [![codecov](https://codecov.io/gh/iwdt/shikikit/graph/badge.svg)](https://codecov.io/gh/iwdt/shikikit) -## Installation +## API Documentation + +* [Shikimori API](https://www.rubydoc.info/gems/shikimori-api) +* [Shikimori OAuth2](https://www.rubydoc.info/gems/shikimori-oauth2) +* [Omniauth Shikimori Strategy](https://www.rubydoc.info/gems/omniauth-shikimori-oauth2) + +## Omniauth Shikimori Strategy + +Strategy to authenticate with Shikimori via OAuth2 in OmniAuth + +[![Gem Version](https://badge.fury.io/rb/omniauth-shikimori-oauth2.svg)](https://rubygems.org/gems/omniauth-shikimori-oauth2) + +### Installation + +Add to your `Gemfile`: + +```ruby +gem 'omniauth-shikimori-oauth2', '~> 1.0' +``` + +Then `bundle install` + +### Configuration + +TODO + +### Usage + +TODO + +### Usage Examples + +## Shikimori OAuth 2 + +A Ruby wrapper for the [Shikimori's OAuth 2](https://shikimori.one/oauth) + +[![Gem Version](https://badge.fury.io/rb/shikimori-oauth2.svg)](https://rubygems.org/gems/shikimori-oauth2) + + +### Installation Install via Rubygems -```sh -gem install shikimori-api shikimori-oauth2 omniauth-shikimori-oauth2 +```bash +gem install shikimori-oauth2 ``` ... or add to your Gemfile ```ruby -gem 'shikimori-api', '~> 1.0' gem 'shikimori-oauth2', '~> 1.0' -gem 'omniauth-shikimori-oauth2', '~> 1.0' ``` Access the library in Ruby: ```ruby -require 'shikimori-api' require 'shikimori-oauth2' -require 'omniauth-shikimori-oauth2' ``` -## Documentation +### Configuration -- (Shikimori API)[https://www.rubydoc.info/gems/shikimori-api] -- (Shikimori OAuth2)[https://www.rubydoc.info/gems/shikimori-oauth2] -- (Omniauth Shikimori Strategy)[https://www.rubydoc.info/gems/omniauth-shikimori-oauth2] +TODO -## Configuration +### Usage TODO -## Usage Examples +## Shikimori API + +Simple wrapper for the Shikimori API + +[![Gem Version](https://badge.fury.io/rb/shikimori-api.svg)](https://rubygems.org/gems/shikimori-api) + +### Installation + +Install via Rubygems + +```bash +gem install shikimori-api +``` + +... or add to your Gemfile + +```ruby +gem 'shikimori-api', '~> 1.0' +``` + +Access the library in Ruby: + +```ruby +require 'shikimori-api' +``` + +### Configuration TODO +### Usage + +TODO