diff --git a/README.md b/README.md index a5050b7..e692780 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,43 @@ -[![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) - # Shikikit Ruby toolkit for the [Shikimori API](https://shikimori.one) -## TODO: -- logger -- #as_app -- proxy config -- oauth methods on API -- optional auto refresh token -- more information at errors -- more tests -- entities for responses -- contracts for requests (client-side validations) -- better documentation -- mutator -- CI/CD -- auto version increment on main branch pushing -- deploy to rubygems +[![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 + +Install via Rubygems + +```sh +gem install shikimori-api shikimori-oauth2 omniauth-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 + +- (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] + +## Configuration + +TODO + +## Usage Examples + +TODO +