walkthrough_awanllm 0.1.11 → 0.1.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa569e0418332a73d3c3b176db2eec63facd6ceff4bd37fb8524c09cb71eea69
-  data.tar.gz: 35532ba5da69b42a158601808a328be0defa3b65905e0f4ad300813362d26ad2
+  metadata.gz: bbf5144f58d9bdea302d3c0065b8febd8bd32ce609ff574769223d33828d2d6b
+  data.tar.gz: 6c392221fa5ed9daa9ce20676e387dfe1f1d3aa935bf42f8a86de8f6accc7637
 SHA512:
-  metadata.gz: 9e3a0b59b472762ca4a74746f84ceab7f44da83da09879e510c3b669dc93fcc9741514bfd364e40764c3ffe7b841bcb0f78a578d87d60ad1e42f6b1288e90500
-  data.tar.gz: c8893a61c9c521dfff2aea0d7e97f800cb6c8018c3e74fb6a5bcf13da84a87db11ee0a5b0fa14a061f5b0b941e87af022c74c210ca4fabd7a470a9fdfa1be6e6
+  metadata.gz: 519508648067ce15e9db529ad760bd7b021e6658277325886e35c2d4fb3b7d7e9a2420b4b4c8fa0cdc23551c9488bc325edb9df158538cdee367a65ff34b46c7
+  data.tar.gz: 4aa5cbd6c9a1a69be8dcb762f3346e5e2b2bd08ec7f50b420fe6fe056c80df67eb320d53bac55c31cdd8b296d8119590ff4a9bc5861d5243f77d65e0fa22bf33

data/README.md

@@ -1,34 +1,83 @@
-# WalkthroughAwanllm
+Here's an updated README for your gem `walkthrough_awanllm`, including all necessary installation and usage instructions, as well as development and contributing guidelines.
 
-TODO: Delete this and the text below, and describe your gem
+```markdown
+# WalkthroughAwanllm
 
-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/walkthrough_awanllm`. To experiment with that code, run `bin/console` for an interactive prompt.
+A Ruby gem to generate a project development walkthrough with the AwanLLM API. This gem helps you log activities and generate detailed walkthroughs of your project's lifecycle.
 
 ## Installation
 
-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.
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'walkthrough_awanllm'
+```
+
+And then execute:
+
+```sh
+$ bundle install
+```
 
-Install the gem and add to the application's Gemfile by executing:
+Or install it yourself as:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```sh
+$ gem install walkthrough_awanllm
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+## Setup
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+After installing the gem, you need to configure it by running the setup script. This will prompt you for your AwanLLM API key and the model name you wish to use.
+
+```sh
+$ ruby bin/setup_awanllm.rb
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Generating Content
+
+To generate content using the AwanLLM API, you can create an instance of the `AwanLLM` class and call its methods:
+
+```ruby
+require 'walkthrough_awanllm'
+
+llm = AwanLLM.new
+response = llm.generate_content(prompt: "Generate some content based on this prompt.")
+puts response
+```
+
+### Generating a Walkthrough
+
+To generate a detailed walkthrough of your project's activities:
+
+```ruby
+llm.generate_walkthrough
+```
+
+This will read the activity log and generate a `walkthrough.md` file in the project's root directory.
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run:
+
+```sh
+$ bundle exec rake install
+```
+
+To release a new version, update the version number in `version.rb`, and then run:
+
+```sh
+$ bundle exec rake release
+```
+
+This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/walkthrough_awanllm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/mruduljohn/walkthrough_awanllm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/mruduljohn/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +85,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the WalkthroughAwanllm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the WalkthroughAwanllm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mruduljohn/walkthrough_awanllm/blob/master/CODE_OF_CONDUCT.md).
+```

data/lib/walkthrough_awanllm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WalkthroughAwanllm
-  VERSION = "0.1.11"
+  VERSION = "0.1.12"
 end

data/walkthrough_awanllm.gemspec

@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
   spec.post_install_message = <<-MESSAGE
     Thank you for installing the AwanLLM gem!
     To complete the setup, please run the following command:
-    setup_awanllm
+    ruby /vendor/bundle/ruby/YOUR_VERSION/bin/setup_awanllm.rb
   MESSAGE
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: walkthrough_awanllm
 version: !ruby/object:Gem::Version
-  version: 0.1.11
+  version: 0.1.12
 platform: ruby
 authors:
 - Mrudul John
@@ -85,6 +85,7 @@ files:
 - lib/walkthrough_awanllm/railtie.rb
 - lib/walkthrough_awanllm/version.rb
 - sig/walkthrough_awanllm.rbs
+- walkthrough_awanllm-0.1.11.gem
 - walkthrough_awanllm.gemspec
 homepage: https://github.com/mruduljohn/Walkthrough_awanllm_gem
 licenses:
@@ -94,7 +95,7 @@ metadata:
 post_install_message: |2
       Thank you for installing the AwanLLM gem!
       To complete the setup, please run the following command:
-      setup_awanllm
+      ruby /vendor/bundle/ruby/YOUR_VERSION/bin/setup_awanllm.rb
 rdoc_options: []
 require_paths:
 - lib