README.md in anyway_config-2.5.4 vs README.md in anyway_config-2.6.0
- old
+ new
@@ -736,11 +736,11 @@
It's useful to have a personal, user-specific configuration in development, which extends the project-wide one.
We support this by looking at _local_ files when loading the configuration data:
- `<config_name>.local.yml` files (next to\* the _global_ `<config_name>.yml`)
-- `config/credentials/local.yml.enc` (for Rails >= 6, generate it via `rails credentials:edit --environment local`).
+- `config/credentials/local.yml.enc` (for Rails >= 7.1, generate it via `rails local_credentials:edit`; for Rails >= 6.0, <7.1 you can also use `rails credentials:edit -e local`).
\* If the YAML config path is not a default one (i.e., set via `<CONFIG_NAME>_CONF`), we look up the local
config at this location, too.
Local configs are meant for using in development and only loaded if `Anyway::Settings.use_local_files` is `true` (which is true by default if `RACK_ENV` or `RAILS_ENV` env variable is equal to `"development"`).
@@ -1052,10 +1052,16 @@
## RBS support
Anyway Config comes with Ruby type signatures (RBS).
-To use them with Steep, add `library "anyway_config"` to your Steepfile.
+To use them with Steep, add the following your `Steepfile`:
+
+```ruby
+library "pathname"
+library "optparse"
+library "anyway_config"
+```
We also provide an API to generate a type signature for your config class:
```ruby
class MyGem::Config < Anyway::Config