Skip to content
This repository has been archived by the owner on May 21, 2019. It is now read-only.

Add clarity to README, fix broken image link, fix typos #245

Merged
merged 1 commit into from Jan 25, 2017

Conversation

beth
Copy link
Contributor

@beth beth commented Jan 25, 2017

I was just running through the demo myself, and made a bunch of minor readme fixes.

Listed roughly in order of occurrence -

  1. Add note about needing to create organization and space after signing up for bluemix.
  2. Switch order of login/connect to bluemix from connect, then login => login, then connect.
  3. Add a step to Getting Started to direct human to go to URL (I know it's already implied, but humans!).
  4. Make it explicit that "make a .env file" means "make a file named .env".
  5. Make explicit that installing node will also install npm.
  6. Format npm start and npm install to indicate terminal command.
  7. Indicate optional for all optional environment variables.
  8. Rephrase sentence about OVERRIDE_CLASSIFIER_ID to match sentence structure of other env variable descriptions.
  9. Fix broken tooltip image link.
  10. Fix typo of localy => locally.
  11. Remove extraneous spaces.
  12. Make periods at end of lines consistent.
  13. Turn node and npm links into reference links.

Copy link
Contributor

@kognate kognate left a comment

Choose a reason for hiding this comment

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

Looks good. Thank you for doing this.

@kognate kognate merged commit 6140a73 into germanattanasio:master Jan 25, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants