x

README.md

@@ -1,26 +1,35 @@
 # Telebugs for Ruby
 
-> Simple error monitoring for developers. Monitor production errors in real-time
-> and get them reported to Telegram with Telebugs
->
-> https://telebugs.com
+Simple error monitoring for developers. Monitor production errors in real-time
+and get them reported to Telegram with Telebugs.
 
-- Telebugs News: [https://t.me/telebugs](https://t.me/TelebugsNews)
-- Telebugs Community: [https://t.me/TelebugsCommunity](https://t.me/TelebugsCommunity)
+- [FAQ](https://telebugs.com/faq)
+- [Telebugs News](https://t.me/TelebugsNews)
+- [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.
+## Introduction
+
+Any Ruby application or script can be integrated with
+[Telebugs](https://telebugs.com) using the `telebugs` gem. The gem is designed
+to be simple and easy to use. It provides a simple API to send errors to
+Telebugs, which will then be reported to your Telegram project. This guide will
+help you get started with Telebugs for Ruby.
+
+For full details, please refer to the [Telebugs documentation](https://telebugs.com/new/docs/integrations/ruby).
 
 ## 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
 
@@ -35,9 +44,9 @@ Telebugs.configure do |c|
 end
 
 begin
-  1/0
+  1 / 0
 rescue ZeroDivisionError => e
-  Telebugs.notify(error: e).wait
+  Telebugs.notify(error: e)
 end
 
 sleep 2
@@ -47,6 +56,23 @@ 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](http://t.me/TelebugsBot) for your API key or find it in
+your project's dashboard.
+
+## Telebugs for Ruby integrations
+
+- [Ruby on Rails](https://github.com/telebugs/telebugs-rails)
+
+## Ruby support policy
+
+Telebugs for Ruby supports the following Ruby versions:
+
+- Ruby 3.0+
+
+If you need support for Ruby 2.7 or 2.6, please let us know or any other Ruby
+implementation.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run