Skip to content

Minor wording suggestions for README.md #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jackieros wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Minor wording suggestions for README.md #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4cf2be
Update README.md
jackieros Apr 8, 2021
7ff9949
version values should be referred to as "earlier/later".
jackieros Apr 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Use a version of **Ruby >= 2.4**. In this repo, we are using version 2.5.7 as i

### Mac
Mac comes with Ruby installed.
To install the latest version of Ruby, use HomeBrew. You can [install Homebrew](https://brew.sh/)
To install the latest version of Ruby, use [Homebrew](https://brew.sh/):

```bash
brew install ruby
Expand All @@ -22,14 +22,14 @@ The scripts are run from the `scripts` directory.

1. Clone this repo.

2. Install Cloudinary gem.
2. Install the Cloudinary gem:

```bash
`gem install cloudinary`
```
3. Set up credentials.

Create a `./scripts/config.rb` file and copy the value from the ClOUDINARY_URL located in the Cloudinary [Management Console](https://cloudinary.com/console) into the file as an argument for the `config_from_url` command. See the `config.rb.sample`. The code below shows two alternatives for adding credentials.
Create a `./scripts/config.rb` file and copy the ClOUDINARY_URL value from your Cloudinary [Management Console](https://cloudinary.com/console) into the file as an argument for the `config_from_url` command. See the [config.rb.sample](/scripts/config.rb.sample). The code below shows two alternatives for adding credentials.
Copy link
Author

@jackieros jackieros Apr 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These instructions relate only to one of the alternatives & ignore the 2nd.
Perhaps makes more sense to have these instructions (without mentioning "two alternatives"), then show just the Cloudinary.config_from_url syntax.

And then below that, say "Alternatively, you can configure each of the required parameters separately as follows:
And then show the Cloudinary.config do option...


There are two ways you can make the credentials available.

Expand All @@ -43,7 +43,7 @@ Cloudinary.config_from_url("cloudinary://API_KEY:API_SECRET@CLOUD_NAME")
```

## Exercises
You will see that the images and video to be used in the exercises are in the `assets` directory. Scripts access assets relative to the scripts directory, so navigate to the `scripts` directory.
The images and videos to be used in the exercises are located in the [assets](/scripts/assets/) directory. The scripts access assets relative to the `scripts` directory, so navigate to the `scripts` directory.

```bash
cd scripts
Expand All @@ -64,7 +64,7 @@ Commands are commented out in each script. You can uncomment and run script or

## Using Ruby/IRB (optional)

You need version 2.4 or higher of Ruby to use Ruby/IRB. This will allow you to experiment with your own commands interactively. Once you have set up the `config.rb`, the `scripts/bin/console.rb` will be able to access your credentials. From the `scripts` directory, run the following:
You need version 2.4 or later of Ruby to use Ruby/IRB. This will allow you to experiment with your own commands interactively. Once you have set up the `config.rb`, the `scripts/bin/console.rb` will be able to access your credentials. From the `scripts` directory, run the following:

```bash
ruby bin/console.rb
Expand Down