Skip to content

Commit

Permalink
x
Browse files Browse the repository at this point in the history
  • Loading branch information
kyrylo committed Jun 14, 2024
1 parent 3243486 commit 3cfbd37
Showing 1 changed file with 17 additions and 8 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# Telebugs for Ruby

##### Simple error monitoring for developers. Monitor production errors in real-time and get them reported to Telegram with Telebugs
#### Simple error monitoring for developers. Monitor production errors in real-time and get them reported to Telegram with Telebugs

- https://telebugs.com
## Resources

- [FAQ](https://telebugs.com/faq)
- [Telebugs News](https://t.me/TelebugsNews)
- [TelebugsCommunity](https://t.me/TelebugsCommunity)
- [Telebugs Community](https://t.me/TelebugsCommunity)

Any Ruby application or script can be integrated with Telebugs using the
`telebugs` gem. In this guide, you will learn how to install and configure
Telebugs in your Ruby application or script.
`telebugs` gem.

## Installation

Install the gem and add to the application's Gemfile by executing:

bundle add telebugs
```sh
bundle add telebugs
```

If bundler is not being used to manage dependencies, install the gem by executing:

gem install telebugs
```sh
gem install telebugs
```

## Usage

Expand All @@ -35,7 +40,7 @@ end
begin
1/0
rescue ZeroDivisionError => e
Telebugs.notify(error: e).wait
Telebugs.notify(error: e)
end

sleep 2
Expand All @@ -45,6 +50,10 @@ puts "An error was sent to Telebugs asynchronously.",
"A notification was also sent to your Telegram chat."
```

Replace `YOUR_API_KEY` with your actual API key. You can ask
[@TelebugsBot](tg://resolve?domain=telebugsbot) for your API key or find it in
your project's dashboard.

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run
Expand Down

0 comments on commit 3cfbd37

Please sign in to comment.