ruby-chatgpt 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14be782a508a9479bd23945bd1de0554c7ccdf2f0243b4788b6dc79977f548d3
-  data.tar.gz: 958ffce17c2776260214aaaaa37bb682bb8d483924d9b494eb55de3cbc387bbd
+  metadata.gz: cebb900d9cb94e14b4d1eed53454509b44e43447aa194825aab559a97523da5c
+  data.tar.gz: 480a699c71ae43d1afe7170c50dbfb088184c60ef432328973b8429f56555b41
 SHA512:
-  metadata.gz: 8ffefabce2b54396e3d032dca65e1846b102151b70ef2fa796ab580f107ac5bf5f378fc88f03e49db529169a1896361baf358df2e70d9c54adaa3daf8248ddcc
-  data.tar.gz: e04712afcbec760250ad8e78b7d7c66b48076a2b7f78556a8f3eef2250c757bdacf3c981fbfb538a9206bf4cfa5c831e83826b05d217efb0b1c9c9e1d9a3f567
+  metadata.gz: 770734dbc5a0710adba4d1a482e90e6465543f6361e473e6786a6cc208acf2d6fa006cffe0aa8e5cc84daef4a5a9c6971ae8a4584316185fd2a02b9ea5928b12
+  data.tar.gz: cbc5d7efa431da839c203eebb34a7570b34b3ac4b3c3eb80a3b301c0468a24cb56112dfc9571232956931c69a545c550dc461103bacab927096d22cbf6f7ca52

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [Unreleased]
+# Changelog
+
+## [0.1.2] - 2023-05-07
+
+### Changed
+
+- Update README to showcase installation and usage
+- Update `.gemspec` with homepage and source code uri's
+- Ignore \*.gem files in git
 
 ## [0.1.0] - 2023-05-06
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ruby-chatgpt (0.1.1)
+    ruby-chatgpt (0.1.2)
       ruby-openai (~> 4.0)
 
 GEM

data/README.md

@@ -1,32 +1,47 @@
-# Ruby::Chatgpt
+# Ruby ChatGPT
 
-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/ruby/chatgpt`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/ruby-chatgpt.svg)](https://badge.fury.io/rb/ruby-chatgpt)
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/richo225/ruby-chatgpt/blob/main/LICENSE.txt)
 
-TODO: Delete this and the text above, and describe your gem
+CLI for interacting and conversing with [OpenAI](https://platform.openai.com/docs/api-reference/chat).
 
-## Installation
+Stream text with GPT-3.5 from the command line! 🌊🤖
 
-Install the gem and add to the application's Gemfile by executing:
+Demo for an article I wrote on my [blog](https://richardbates.dev/blog/2023-05-05).
 
-    $ bundle add ruby-chatgpt
+## Installation
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install the gem:
 
-    $ gem install ruby-chatgpt
+```shell
+$ gem install ruby-chatgpt
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+- Get your API key from [https://platform.openai.com/account/api-keys](https://platform.openai.com/account/api-keys).
+- Set this value to the `OPENAI_API_KEY` environment variable.
+
+Run the `chatgpt` executable:
+
+```shell
+    $ chatgpt
+    => Enter a prompt (or "exit" to quit): What is the capital of Taiwan?
+    The capital of Taiwan is Taipei.
+    => Enter a prompt (or "exit" to quit): How many people live in Taipei?
+    As an AI language model, I do not have access to real-time data. However, according to the United Nations, the estimated population of Taipei in 2021 is around 2.8 million.
+    => Enter a prompt (or "exit" to quit):
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 `bundle exec rake install`.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ruby-chatgpt. 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]/ruby-chatgpt/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/richo225/ruby-chatgpt. 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]/ruby-chatgpt/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/lib/ruby/chatgpt/version.rb

@@ -2,6 +2,6 @@
 
 module Ruby
   module Chatgpt
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-chatgpt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Richard Bates
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-openai
@@ -24,7 +24,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
-description: CLI interface for OpenAI ChatGPT in Ruby
+description: "CLI interface for OpenAI ChatGPT in Ruby \U0001F30A\U0001F916"
 email:
 - rich.bates@protonmail.com
 executables:
@@ -46,10 +46,13 @@ files:
 - lib/ruby/chatgpt/version.rb
 - ruby-chatgpt-0.1.0.gem
 - sig/ruby/chatgpt.rbs
-homepage: 
+homepage: https://github.com/richo225/ruby-chatgpt
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/richo225/ruby-chatgpt
+  source_code_uri: https://github.com/richo225/ruby-chatgpt
+  changelog_uri: https://github.com/richo225/ruby-chatgpt/blob/main/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -68,5 +71,5 @@ requirements: []
 rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
-summary: CLI interface for OpenAI ChatGPT in Ruby
+summary: "CLI interface for OpenAI ChatGPT in Ruby \U0001F30A\U0001F916"
 test_files: []