shelp 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ba623ebc99c85369960fcffb8efb8c2a3cb223b1fca5f93ccfe3ecf098bdd8d
-  data.tar.gz: 885278d5298b8081a0f2b8f32bbe5cb79e69e19525699814f107dcaae2875c23
+  metadata.gz: 7bab3c5dcc988037aafb8f79226e4357afecc18cb7f476e9d4cbeb79573b05fa
+  data.tar.gz: 9751cf3e75e595ced1de51ebd4924a182c3370ae3cea59d62a718ed3dcc66050
 SHA512:
-  metadata.gz: 8034f49d04d28af1f42a8aa193c1566e62c44977f1bd134c7adad584661e6e2107ad17fff9391ace30174bddf8901aeb96ea7a2c365f307481af1bb846940dbb
-  data.tar.gz: 192ba9e7229cc02add4d343bc7d03d37dde31899855e1109e5a930f9d72812fbc126445f08b5d07256fb31f540d8a07d7a13887784c463a54b90d775a033f10f
+  metadata.gz: '03995ff70ac91387a80a82dd0f851b4d1ce2bfdc46110233dae8413a18901ba2b616bc35673b24b4c4aad533a0b458f0e74f021e51a48804139c830cb1b8da0c'
+  data.tar.gz: eb5ac32d118f44d316414495b09dd4fd1f2d3b11c6000e805b571f07db658a810e9857442e7a62310999aa3d3aa6ed7f32633e3f08c2076aec77da9de55994a2

data/README.md

@@ -1,24 +1,32 @@
 # Shelp
 
-TODO: Delete this and the text below, and describe your gem
+A command line tool that translates natural language into shell commands, using OpenAI's GPT models.
 
-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/shelp`. To experiment with that code, run `bin/console` for an interactive prompt.
+DISCLAIMER: This is work in progress and might be rough around the edges. Please be patient and report any issues you encounter.
 
 ## 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.
+Install the gem by executing:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+gem install shelp
+```
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+## Usage
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+To use the tool, you need to have an OpenAI API key. You can get one by signing up at [OpenAI](https://platform.openai.com/signup).
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Once you have your API key, you can set it as an environment variable:
 
-## Usage
+```bash
+export OPENAI_API_KEY=your-api-key
+```
+
+Then you can run the CLI by executing:
 
-TODO: Write usage instructions here
+```bash
+shelp ask "How do I list files in a directory?"
+```
 
 ## Development
 
@@ -28,7 +36,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/shelp. 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]/shelp/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at <https://github.com/zackbraksa/shelp>. 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/zackbraksa/shelp/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +44,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Shelp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/shelp/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Shelp project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/zackbraksa/shelp/blob/main/CODE_OF_CONDUCT.md).

data/lib/shelp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Shelp
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shelp
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Zack Braksa