From f2af7358df83e040a65171280bf166591917714d Mon Sep 17 00:00:00 2001 From: Kyrylo Silin Date: Wed, 19 Jun 2024 17:57:10 +0300 Subject: [PATCH] Improve README --- README.md | 31 ++++++++++++++++++++----------- 1 file changed, 20 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a9a873c..0269283 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,33 @@ -# Telebugs::Rails +# Telebugs for Rails -TODO: Delete this and the text below, and describe your gem +Simple error monitoring for developers. Monitor production errors in real-time +and get them reported to Telegram with Telebugs. -Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/telebugs/rails`. To experiment with that code, run `bin/console` for an interactive prompt. +- [FAQ](https://telebugs.com/faq) +- [Telebugs News](https://t.me/TelebugsNews) +- [Telebugs Community](https://t.me/TelebugsCommunity) -## Installation +## Introduction -TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org. +Any Ruby on Rails application can be integrated with +[Telebugs](https://telebugs.com) using the `telebugs-rails` gem. The gem is +designed to be simple and easy to use. It integrates the `telebugs` gem with +Rails application, so that any unhandled error occurring in your app will be +reported to Telebugs. -Install the gem and add to the application's Gemfile by executing: +## Installation - $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG +For the integration details, please refer to the +[Telebugs documentation](https://telebugs.com/new/docs/integrations/rails). -If bundler is not being used to manage dependencies, install the gem by executing: +## Rails support policy - $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG +Telebugs for Rails supports the following Rails versions: -## Usage +- Rails 6.1+ -TODO: Write usage instructions here +If you need support older Rails version, please contact us at +[help@telebugs.com](mailto:help@telebugs.com). ## Development