CONTRIBUTING.md in forbes-finder-0.1.1 vs CONTRIBUTING.md in forbes-finder-0.1.2
- old
+ new
@@ -1,12 +1,20 @@
# Contributing to Forbes Finder
## Creating aliases / subsidiaries
-Ebay is listed in the Forbes 2000, but it's domain is listed as `ebayinc.com`. In order for ForbesFinder to recognize `ebay.com` or `paypal.com` (both subsidiaries) we need to set up some alises. It's pretty easy to - just use git to store symlinks to the existing TOML files e.g.
+In this example, there's a file called `ebayinc.com.toml` with the following contents:
+```toml
+name = "eBay"
+domain = "ebayinc.com"
+rank = 322
```
+
+That file ensures that `ebayinc.com` will be recognized as a Forbes 2000 company. To ensure that `paypal.com` and `ebay.com` are both recognized, we'll need to add two additional files `ebay.com.toml` and `paypal.com.toml` that are symlinks to `ebayinc.com.toml`:
+
+```
cd lib/data/2012
ln -s ebayinc.com.toml ebay.com.toml
git add ebay.com.toml
git commit -m "Add alias for ebay.com"
git push origin master
@@ -18,6 +26,6 @@
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
* Start a feature/bugfix branch.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
\ No newline at end of file