Skip to content

Commit

Permalink
Fix CI, update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
blacksam07 committed Feb 13, 2024
1 parent beaddb6 commit ace189d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,10 @@ jobs:
timeout-minutes: 1
- name: Test & publish code coverage
uses: paambaati/[email protected]
if: matrix.coverage
env:
CC_TEST_REPORTER_ID: ${{ env.CC_TEST_REPORTER_ID }}
with:
coverageCommand: bundle exec rspec
coverageLocations: ${{ github.workspace }}/coverage/coverage.json:simplecov
debug: true
if: matrix.coverage
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AppleAuth

[![CI](https://api.travis-ci.com/rootstrap/apple_auth.svg?branch=master)](https://travis-ci.com/github/rootstrap/apple_auth)
[![Gem Version](https://badge.fury.io/rb/apple_auth.svg)](https://badge.fury.io/rb/apple_auth)
[![Maintainability](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/maintainability)](https://codeclimate.com/github/rootstrap/apple_sign_in/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/78453501221a76e3806e/test_coverage)](https://codeclimate.com/github/rootstrap/apple_sign_in/test_coverage)

Expand All @@ -20,13 +20,14 @@ Or install it yourself:

$ gem install apple_auth

------------------
---

After installing the gem, you need to run this generator.

$ rails g apple_auth:config

This will generate a new initializer: `apple_auth.rb` with the following default configuration:

```ruby
AppleAuth.configure do |config|
# config.apple_client_id = <Your client_id in your Apple Developer account>
Expand All @@ -36,9 +37,10 @@ AppleAuth.configure do |config|
# config.redirect_uri = <Your app redirect url>
end
```

Set your different credentials in the file by uncommenting the lines and adding your keys.

------------------
---

## Usage

Expand Down Expand Up @@ -143,6 +145,7 @@ An example `$ rails g apple_auth:apple_auth_controller api/v1/`
This will generate a new controller: `controllers/api/v1/apple_auth_controller.rb`.

You should configure the route, you can wrap it in the devise_scope block like:

```
devise_scope :user do
resource :user, only: %i[update show] do
Expand All @@ -167,7 +170,6 @@ To install this gem onto your local machine, run `bundle exec rake install`. To

Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/apple_auth/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/rootstrap/apple_auth/blob/master/CODE_OF_CONDUCT.md).


## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
Expand Down

0 comments on commit ace189d

Please sign in to comment.