walkthrough_awanllm 0.1.1 → 0.1.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 4f4b8b2dda25499d5a831efefe5538b0b0011061edf1eebc5c8e9e627f9a84b7
4
- data.tar.gz: c3f7eab6972b222a356aad93687a5e09998c5ed5fab5b572f7c50d2e66a2e332
3
+ metadata.gz: bbf5144f58d9bdea302d3c0065b8febd8bd32ce609ff574769223d33828d2d6b
4
+ data.tar.gz: 6c392221fa5ed9daa9ce20676e387dfe1f1d3aa935bf42f8a86de8f6accc7637
5
5
  SHA512:
6
- metadata.gz: f6721772222bd6f7fd464c900e0c0badd24328c32baa88ac7e48b5b6c8dcd1b97e85fc30762c1888067c079c12f75595e9abc8b903b228be59d30f77a2c54a83
7
- data.tar.gz: 72f36b1397dc05a8609f46f7bfaa6513b20852a5c35b9ac65e2019ccdd4dc9a0ff78bc279b9bb5974e8f5df073960d2920d8394da400bb7a348be99c2a06aab2
6
+ metadata.gz: 519508648067ce15e9db529ad760bd7b021e6658277325886e35c2d4fb3b7d7e9a2420b4b4c8fa0cdc23551c9488bc325edb9df158538cdee367a65ff34b46c7
7
+ data.tar.gz: 4aa5cbd6c9a1a69be8dcb762f3346e5e2b2bd08ec7f50b420fe6fe056c80df67eb320d53bac55c31cdd8b296d8119590ff4a9bc5861d5243f77d65e0fa22bf33
data/README.md CHANGED
@@ -1,34 +1,83 @@
1
- # WalkthroughAwanllm
1
+ Here's an updated README for your gem `walkthrough_awanllm`, including all necessary installation and usage instructions, as well as development and contributing guidelines.
2
2
 
3
- TODO: Delete this and the text below, and describe your gem
3
+ ```markdown
4
+ # WalkthroughAwanllm
4
5
 
5
- 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.
6
+ 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.
6
7
 
7
8
  ## Installation
8
9
 
9
- 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.
10
+ Add this line to your application's Gemfile:
11
+
12
+ ```ruby
13
+ gem 'walkthrough_awanllm'
14
+ ```
15
+
16
+ And then execute:
17
+
18
+ ```sh
19
+ $ bundle install
20
+ ```
10
21
 
11
- Install the gem and add to the application's Gemfile by executing:
22
+ Or install it yourself as:
12
23
 
13
- $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
24
+ ```sh
25
+ $ gem install walkthrough_awanllm
26
+ ```
14
27
 
15
- If bundler is not being used to manage dependencies, install the gem by executing:
28
+ ## Setup
16
29
 
17
- $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
30
+ 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.
31
+
32
+ ```sh
33
+ $ ruby bin/setup_awanllm.rb
34
+ ```
18
35
 
19
36
  ## Usage
20
37
 
21
- TODO: Write usage instructions here
38
+ ### Generating Content
39
+
40
+ To generate content using the AwanLLM API, you can create an instance of the `AwanLLM` class and call its methods:
41
+
42
+ ```ruby
43
+ require 'walkthrough_awanllm'
44
+
45
+ llm = AwanLLM.new
46
+ response = llm.generate_content(prompt: "Generate some content based on this prompt.")
47
+ puts response
48
+ ```
49
+
50
+ ### Generating a Walkthrough
51
+
52
+ To generate a detailed walkthrough of your project's activities:
53
+
54
+ ```ruby
55
+ llm.generate_walkthrough
56
+ ```
57
+
58
+ This will read the activity log and generate a `walkthrough.md` file in the project's root directory.
22
59
 
23
60
  ## Development
24
61
 
25
62
  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.
26
63
 
27
- 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).
64
+ To install this gem onto your local machine, run:
65
+
66
+ ```sh
67
+ $ bundle exec rake install
68
+ ```
69
+
70
+ To release a new version, update the version number in `version.rb`, and then run:
71
+
72
+ ```sh
73
+ $ bundle exec rake release
74
+ ```
75
+
76
+ 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).
28
77
 
29
78
  ## Contributing
30
79
 
31
- 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).
80
+ 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).
32
81
 
33
82
  ## License
34
83
 
@@ -36,4 +85,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
36
85
 
37
86
  ## Code of Conduct
38
87
 
39
- 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).
88
+ 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).
89
+ ```
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module WalkthroughAwanllm
4
- VERSION = "0.1.1"
4
+ VERSION = "0.1.12"
5
5
  end
Binary file
@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
9
9
  spec.email = ["mrudulmathews@gmail.com"]
10
10
 
11
11
  spec.summary = "A Ruby gem to Generate Project Development Walkthrough with the AwanLLM API."
12
- spec.description = "A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM API for generating and retrieving content."
12
+ spec.description = "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM API for generating and retrieving content."
13
13
  spec.homepage = "https://github.com/mruduljohn/Walkthrough_awanllm_gem"
14
14
  spec.license = "MIT"
15
15
  spec.required_ruby_version = ">= 3.0.0"
@@ -39,6 +39,6 @@ Gem::Specification.new do |spec|
39
39
  spec.post_install_message = <<-MESSAGE
40
40
  Thank you for installing the AwanLLM gem!
41
41
  To complete the setup, please run the following command:
42
- setup_awanllm
42
+ ruby /vendor/bundle/ruby/YOUR_VERSION/bin/setup_awanllm.rb
43
43
  MESSAGE
44
44
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: walkthrough_awanllm
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - Mrudul John
@@ -66,8 +66,8 @@ dependencies:
66
66
  - - "~>"
67
67
  - !ruby/object:Gem::Version
68
68
  version: '5.0'
69
- description: A Ruby gem to generate a walkthrough the project lifecycle with the AwanLLM
70
- API for generating and retrieving content.
69
+ description: "{UNDER DEVELOPMENT NOT FOR USE YET}A Ruby gem to generate a walkthrough
70
+ the project lifecycle with the AwanLLM API for generating and retrieving content."
71
71
  email:
72
72
  - mrudulmathews@gmail.com
73
73
  executables:
@@ -85,6 +85,7 @@ files:
85
85
  - lib/walkthrough_awanllm/railtie.rb
86
86
  - lib/walkthrough_awanllm/version.rb
87
87
  - sig/walkthrough_awanllm.rbs
88
+ - walkthrough_awanllm-0.1.11.gem
88
89
  - walkthrough_awanllm.gemspec
89
90
  homepage: https://github.com/mruduljohn/Walkthrough_awanllm_gem
90
91
  licenses:
@@ -94,7 +95,7 @@ metadata:
94
95
  post_install_message: |2
95
96
  Thank you for installing the AwanLLM gem!
96
97
  To complete the setup, please run the following command:
97
- setup_awanllm
98
+ ruby /vendor/bundle/ruby/YOUR_VERSION/bin/setup_awanllm.rb
98
99
  rdoc_options: []
99
100
  require_paths:
100
101
  - lib