https://github.com/deanpcmad/gitearb

Last synced: about 2 months ago
JSON representation

Ruby library for the Gitea API

Host: GitHub
URL: https://github.com/deanpcmad/gitearb
Owner: deanpcmad
License: mit
Created: 2023-02-06T14:03:58.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2023-02-15T08:21:27.000Z (about 2 years ago)
Last Synced: 2025-02-03T14:37:05.827Z (3 months ago)
Language: Ruby
Homepage:
Size: 16.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt

README

# GiteaRB

GiteaRB is a Ruby library for the Gitea API.

## Installation

Add this line to your application's Gemfile:

```ruby
gem "gitearb"
```

## Usage

### Set URL and Access Token

Firstly, you'll need to set the URL and Access Token like so:

```ruby
@client = Gitea::Client.new(url: "https://my-gitea-server.com", access_token: "")
```

### User

Retrieve details about the currently authenticated user.

```ruby
# Retrieves details about the current user
@client.user.get

# List all of your email addresses
@client.user.emails
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/gitearb.

## License

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