n2b 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a24dc543659153dabaf892f6bed38934425ac43a1a0b2a263e82c3913e0b5f9
-  data.tar.gz: 01ccd36a76124d3599a7dd26a5cb1f443c4465e21c5cd12505512c00f771a164
+  metadata.gz: 4d669156f98a861c284f95d3f56f9fdad92b5820d288e8f3227e885ed5d13b2a
+  data.tar.gz: e20b7578ff3ca46d9062137a930656e7598c4b613329da1984df09b80adffceb
 SHA512:
-  metadata.gz: 737d3f29477d61da584640389552ebb01809fc762ec6348ee032ca0ab9fe6a3c2360df103fbe8daa3751a980b0b9c41b1998523c5f74f0b6ebb906e5a4a939dc
-  data.tar.gz: 5e975752513f183640c391afd46bd322d80da3a488d046d3e7e487f496b96a65c6bc60fae47de4187e2ca455c41d3aa1a6f23acdd2095f2cccaa36cbacbe8427
+  metadata.gz: ee2d6aaceaea02c667e03f5ff30e6f08c88e27cd9fa3b3fba97f9cd90b1410684d253bf729993a769ef1b3151839cde6f08f7fa99636001027c8e2cfc1713b59
+  data.tar.gz: f10b4515f9191e9f8adb4cacbc6096384f9b6be1697b94f2304130ede32a4360d81f90b9808c4462b8024aeff1982cd54842be64d22085938dbe7cd0b81bd5ab

data/README.md

@@ -13,22 +13,45 @@ N2B (Natural Language to Bash & Ruby) is a Ruby gem that leverages AI to convert
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```bash
+gem install n2b
+```
+
+## Usage
+
+### In IRB/Rails Console
+
+First, require and extend the N2B module:
 
 ```ruby
-gem 'n2b'
+require 'n2b'
+extend N2B::IRB
 ```
 
-And then execute:
+For automatic loading in every IRB session, add these lines to your `~/.irbrc`:
 
-```bash
-$ bundle install
+```ruby
+require 'n2b'
+extend N2B::IRB
 ```
 
-Or install it yourself as:
+After loading, you can use the following commands:
 
-```bash
-$ gem install n2b
+- `n2r` - For general Ruby assistance
+- `n2rrbit` - For Errbit error analysis
+- `n2rscrum` - For generating Scrum tickets
+
+### Examples
+
+```ruby
+# Get help with a Ruby question
+n2r "How do I parse JSON in Ruby?"
+
+# Analyze an Errbit error
+n2rrbit(url: "your_errbit_url", cookie: "your_cookie")
+
+# Generate a Scrum ticket
+n2rscrum "Create a user authentication system"
 ```
 
 ## Configuration
@@ -45,29 +68,6 @@ openai:
   model: gpt-4 # or gpt-3.5-turbo
 ```
 
-## Usage
-
-### Convert Natural Language to Bash
-
-```ruby
-require 'n2b'
-
-# Convert a natural language instruction to a bash command
-N2B::Base.new.n2b("list all jpg files in the current directory")
-# => find . -name "*.jpg"
-```
-
-### Generate Ruby Code
-
-```ruby
-require 'n2b'
-
-# In an IRB console
-n2r("create a function that calculates fibonacci numbers")
-```
-
-This will output both the code and an explanation:
-
 ## Quick Example N2B
 
 ```

data/lib/n2b/version.rb

@@ -1,4 +1,4 @@
 # lib/n2b/version.rb
 module N2B
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: n2b
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Stefan Nothegger