README.md in pg_objects-1.3.0 vs README.md in pg_objects-1.3.1

- old
+ new

@@ -16,11 +16,11 @@ ``` And then execute: ```shell -bundle +bundle install ``` Or install it yourself as: ```shell @@ -33,28 +33,28 @@ bundle exec rails generate pg_objects:install ``` ## Usage -Put DB objects as CREATE (or CREATE OR UPDATE) queries in files to directory structure (default: *db/objects*). +Store DB objects as CREATE (or CREATE OR UPDATE) queries in files within a directory structure (default: *db/objects*). -You can control order of creating by using directive *depends_on* in SQL comment: +You can control the order of creation by using the directive *depends_on* in an SQL comment: ```sql --!depends_on my_another_func CREATE FUNCTION my_func() ... ``` -The string after directive should be a name of file with dependency without extension. +The string after the directive should be the name of the file that the dependency refers to, without the file extension. ## Configuration -You can use either YAML or initializer file to configure the gem. The priority is: +You have the option to configure the gem using either a YAML file or a Ruby initializer. The priority order for configuration is as follows: 1. Ruby initializer -1. YAML config -1. Default values +2. YAML config +3. Default values ### YAML Create `pg_objects.yml` in the application *config* directory: @@ -75,23 +75,23 @@ silent: false ``` ### Initializer -Create file in *config/initializers* with the following content: +Create file in *config/initializers* directory with the following content: ```ruby PgObjects.configure do |config| config.before_path = 'path/to/objects/before' # default: 'db/objects/before' config.after_path = 'path/to/objects/after' # default: 'db/objects/after' config.extensions = ['sql', 'txt'] # default: 'sql' config.silent = true # whether to suppress output to console, default: false end ``` -Otherwise default values will be used. +Otherwise, the default values will be used. -Remember to ensure that the specified directories exist. +Please make sure to verify that the specified directories actually exist. ## Development After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.