ruby_todo 0.3.0 → 0.3.2

data/README.md

@@ -35,6 +35,32 @@ Or install it yourself as:
 $ gem install ruby_todo
 ```
 
+## Quick Start
+
+After installing the gem:
+
+1. Initialize the application:
+   ```bash
+   $ ruby_todo init
+   ```
+
+2. Create your first notebook:
+   ```bash
+   $ ruby_todo notebook create "Personal"
+   ```
+
+3. Add your first task:
+   ```bash
+   $ ruby_todo task add "Personal" "My first task"
+   ```
+
+4. List your tasks:
+   ```bash
+   $ ruby_todo task list "Personal"
+   ```
+
+All `ruby_todo` commands can be run from anywhere in your terminal as they're installed globally with the gem.
+
 ## Usage
 
 ### Initialization
@@ -206,10 +232,26 @@ Templates support the following placeholder types:
 
 ## Development
 
-After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests. You can also run `rubocop` to check the code style.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+### CI/CD
+
+This project uses GitHub Actions for continuous integration and delivery:
+
+- **CI Workflow**: Runs tests and RuboCop on multiple Ruby versions for every push and pull request
+- **Release Workflow**: Automatically increments version number, updates CHANGELOG, creates a GitHub release, and publishes to RubyGems when code is pushed to the main branch
+
+To release a new version, just merge your changes to the main branch. The automation will:
+1. Increment the patch version
+2. Update the CHANGELOG.md file
+3. Run tests to ensure everything works
+4. Build and publish the gem to RubyGems
+5. Create a GitHub release
+
+For manual releases or version changes (major or minor), update the version in `lib/ruby_todo/version.rb` before merging to main.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/jeremiahparrack/ruby_todo.
@@ -217,3 +259,54 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/jeremi
 ## License
 
 The gem is available as open source under the terms of the MIT License.
+
+## Troubleshooting
+
+### Command not found after installation
+
+If you see "command not found" after installing the gem, check the following:
+
+1. Verify the gem is installed:
+   ```bash
+   $ gem list ruby_todo
+   ```
+
+2. Check your gem installation path:
+   ```bash
+   $ gem environment
+   ```
+
+3. Make sure your PATH includes the gem bin directory shown in the environment output.
+
+4. You may need to run:
+   ```bash
+   $ rbenv rehash  # If using rbenv
+   ```
+   or
+   ```bash
+   $ rvm rehash    # If using RVM
+   ```
+
+### Database Issues
+
+If you encounter database issues:
+
+1. Try resetting the database:
+   ```bash
+   $ rm ~/.ruby_todo/ruby_todo.db
+   $ ruby_todo init
+   ```
+
+2. Check file permissions:
+   ```bash
+   $ ls -la ~/.ruby_todo/
+   ```
+
+### Getting Help
+
+Run any command with `--help` to see available options:
+
+```bash
+$ ruby_todo --help
+$ ruby_todo task add --help
+```

data/exe/ruby_todo

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "ruby_todo"
+
+RubyTodo.start