Merge pull request #10 from telebugs/readme

Improve README

LICENSE.md

@@ -0,0 +1,20 @@
+# The MIT License
+
+Copyright © 2024 Telebugs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the 'Software'), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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 versions, please contact us at
+[help@telebugs.com](mailto:help@telebugs.com).
 
 ## Development