README.md in easy_command-1.0.0.pre.rc1 vs README.md in easy_command-1.0.0.pre.rc2
- old
+ new
@@ -60,11 +60,11 @@
$ bundle
Or install it yourself as:
- $ gem install command
+ $ gem install easy_command
# Contributing
To ensure that our automatic release management system works perfectly, it is important to:
@@ -77,11 +77,11 @@
## Automated
Gem publishing and releasing is now automated with [google-release-please](https://github.com/googleapis/release-please).
-Workflow's configuration can be found in `.github/workflows/release.yml`
+The exact configuration of the workflow can be found in `.github/workflows/release.yml`
# Usage
Here's a basic example of a command that check if a collection is empty or not
@@ -732,5 +732,20 @@
it { expect(CollectionChecker).to have_been_called_with_ac_parameters(payload) }
it { expect(CollectionChecker).to have_been_called_with_acp(payload) }
end
```
+
+# Using as `Command`
+
+`EasyCommand` used to be called `Command`. While this was no issue for a private library, it could not stay named that
+way as a public gem. For ease of use and to help smoother transitions, we provide another require entrypoint for the
+library:
+```ruby
+ gem 'easy_command', require: 'easy_command/as_command'
+```
+Requiring `easy_command/as_command` defines a `Command` alias that should provide the same functionality as when the gem was named as such.
+
+**⚠️ This overwrites the toplevel `Command` constant - be sure to use it safely.**
+
+**Also: do remember that any other `require`s should still be updated to `easy_command` though.**
+For example `require 'easy_command/spec_helpers'`.