Readme

jenweber · jenweber · commit 1ab86ce82757 · 2019-06-09T21:48:59.000-04:00
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
-# Octane Classic Comparison
+# Ember Octane vs Classic Cheat Sheet
 
-See side-by-side examples of Classic Ember vs Octane Edition.
+See side-by-side examples of Classic Ember vs [Octane Edition](https://emberjs.com/editions).
 
-This uses [Prism](https://prismjs.com/) code hightlighting.
+This uses [Prism](https://prismjs.com/) code hightlighting with the [file highlight](https://prismjs.com/plugins/file-highlight/) plugin.
+
+Inspired by [YouMightNotNeedJQuery](http://youmightnotneedjquery.com/).
 
 ## Running locally
 
@@ -15,3 +17,19 @@ http-server .
 
 Visit http://localhost:8080 to see the results.
 If you make changes, restart the server.
+You might have to clear the cache to see your changes. (In Chrome, open the dev tools, then right click on the browser's main refresh arrow and choose Empty Cache and Hard Reload, or configure your dev tools to not keep a cache in the first place.)
+
+## Contributing
+
+Contributions are welcome!
+Simple examples can be added to this cheat sheet.
+Copy and paste a `<section>` block in `index.html`.
+Create the code sample files in the `code` directory, change the `data` tag of the `<pre>`, and you're done!
+Try to follow the same file naming scheme as is used elsewhere, and make sure to name any `.hbs` files `.handlebars` instead or the formatting won't get applied.
+
+Advanced strategies should be PR'd directly to the [Ember.js Guides](https://github.com/ember-learn/guides-source/pulls), since the goal of this project is to keep it as short and sweet as possible.
+
+## Deploying
+
+This site is deployed to [GitHub Pages](https://pages.github.com/) automatically from the `master` branch.
+
diff --git a/index.html b/index.html
@@ -9,7 +9,7 @@
   <body>
 		<script src="lib/prism.js"></script>
 		<h1>Ember.js Octane vs Classic Cheat Sheet</h1>
-		<p>This guide is a cheat sheet. It doesn't cover everything, but it should get you started!</p>
+		<p>This guide is a cheat sheet for using <a href="https://emberjs.com/editions/octane">Ember.js Octane</a>. It doesn't cover everything, but it should get you started!</p>
 
 		<hr>
 		<h2>Component Templates</h2>
