README.md in nutrella-0.5.0 vs README.md in nutrella-0.6.0
- old
+ new
@@ -7,12 +7,12 @@
A command line tool for associating a Trello board with the current git branch.
## Table of Contents
* [Installation](#installation)
-* [Troubleshooting](#troubleshooting)
* [Usage](#usage)
+* [Troubleshooting](#troubleshooting)
* [Origin of Name](#origin-of-name)
* [Contributing](#contributing)
* [License](#license)
@@ -24,12 +24,13 @@
**Step 2**: Create configuration file
$ nutrella
-**Step 3**: Get key and secret
+**Step 3**: Get key and secret (best to do this from your home directory)
+ $ cd ~
$ irb -rubygems
irb> require 'nutrella'
irb> Nutrella.open_public_key_url
Insert your `key` and `secret` into your `~/.nutrella.yml` file.
@@ -52,10 +53,19 @@
token: 4c13558cbafdcb4765103a195e05b0476f3b3f7f3efc83f2a810fb769f4ae2d6
# Optional Configuration
organization: 542d76ac2fad4697c3e80448
+
+## Usage
+
+Create or open a Trello board based on the name of the current git branch:
+
+ $ nutrella
+
+Note: you can invoke the `nutrella` from your project directory or from any subdirectory.
+
## Troubleshooting
### `method_missing: undefined method 'this'`
Try updating `RubyGems`
@@ -64,22 +74,22 @@
gem update --system
```
### `uninitialized constant Gem::Source (NameError)`
-Try updating `bundler`
+Try updating `bundler`
```sh
gem install bundler
```
-For more information see the `bundler` [CHANGELOG]( https://github.com/bundler/bundler/blob/master/CHANGELOG.md#1131-2016-09-13)
+### `cannot load such file -- nutrella`
-## Usage
+This error may appear after running `irb -rubygems` and you are unable to `require 'nutrella'`. You won't be able to `require 'nutrella'` from a directory that uses Bundler. Try running `irb` instead from your home directory:
-Create or open a Trello board based on the name of the current git branch:
-
- $ nutrella
+```sh
+cd ~
+```
## Origin of Name
Nutrella is a [portmanteau](https://en.wikipedia.org/wiki/Portmanteau) that combines these three words: