Skip to content

Commit

Permalink
update usage section (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
juliocabrera820 authored May 3, 2024
1 parent ea79867 commit 87afc94
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Publish ruby gem action

Action that builds a gem based on a gemspec and publish it to GitHub packages or Rubygems
Action that builds a gem based on a gemspec and publishes to GitHub packages or Rubygems

## Usage

```yml
steps:
- name: Example
id: example
uses: actions/example@v1
---
- name: Publish gem to rubygems or gh packages
uses: juliocabrera/publish-ruby-gem-action@v1
with:
github_token: ${{secrets.GITHUB_TOKEN}} # optional
rubygems_api_key: ${{secrets.RUBYGEMS_API_KEY}} # optional
github_username: octocat # optional: default value is your username in github
```

0 comments on commit 87afc94

Please sign in to comment.