Skip to content
This repository has been archived by the owner on Apr 27, 2021. It is now read-only.

Updated README.md file #135

Merged
merged 5 commits into from
Feb 3, 2015
Merged

Updated README.md file #135

merged 5 commits into from
Feb 3, 2015

Conversation

spuddick
Copy link
Contributor

No description provided.

@csaunders
Copy link
Contributor

What's the context for this change?

@spuddick
Copy link
Contributor Author

Here is what I have done:

  • more detailed explanation of setup
  • more detailed explanation of commands and how they work, as well as introduce some details not present in the current documentation
  • added a new 'Tips and Tricks' section
  • Reworded the 'Common Problems' section

@csaunders
Copy link
Contributor

fixes #131

First time installing Ruby on windows? Try [Rubyinstaller](http://http://rubyinstaller.org/).
## Requirements
This gem works with OS X or Windows with Ruby 1.9.
First time installing Ruby on windows? Try Rubyinstaller.
Copy link
Contributor

Choose a reason for hiding this comment

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

Windows

Copy link
Contributor

Choose a reason for hiding this comment

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

This might make more sense as unordered list or separate them by extra newlines. It's all showing up on one line through the magic of markdown.

@csaunders
Copy link
Contributor

It needs a bit of work but thanks a bunch for going through and organizing this. It's definitely better than what we had.


[![Gem Version](https://badge.fury.io/rb/shopify_theme.svg)](http://badge.fury.io/rb/shopify_theme)
Copy link
Contributor

Choose a reason for hiding this comment

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

We need this so that people know what the current gem version is.

@spuddick
Copy link
Contributor Author

spuddick commented Feb 3, 2015

Cool. Thanks for the feedback. I never actually fully realized how the line breaks work in mark down until now! Take a look at what I have now.

@csaunders
Copy link
Contributor

Builds are broken but that's not your fault. I'll figure out what's going on here. Doesn't affect this though, so nbd.

Thanks for the contribution! ❤️

csaunders added a commit that referenced this pull request Feb 3, 2015
@csaunders csaunders merged commit d376bba into Shopify:master Feb 3, 2015
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.

2 participants