Create README.md

README.md

@@ -0,0 +1,40 @@
+# BadDreamsDemo
+A demo game showcasing how to use the "WordPress For Unity" asset for Unity
+
+This was the first demo game created for (and released with) the WordPress For Unity asset. 
+<strong>The WordPress For Unity code source remains propietary and is not included in this demo project.
+As such this demo will only be of use to those who own either of the two WordPress For Unity asset editions</strtong>
+
+<hr>
+<h3>What is included?</h3>
+<ul><li>For the base of the demo we used the 3rd person shooter provided by Unity.</li>
+<li>We then added 2 more weapon types</li>
+<li>We added an upgrade and stats system to the weapons</li>
+<li>We added in a store where you could unlock the new weapons, upgrade them or purchase ammo</li>
+<li>We then incorporated the WordPress For Unity asset to include the following features:
+  <ul><li>A currency system based on performance in game</li>
+  <li>Save unlocks, upgrades and ammo online</li>
+  <li>A global leaderboards system available from the main menu showing the top 10 players</li>
+  <li>Login to fetch your weapons, ammo, stats, best score, available currency and your Gravatar icon</li>
+  <li>Unlock achievements for play and kill count, also viewable on the main menu</li>
+  <li>In game notifications of when awards were unlocked</li>
+  <li>We added the serials system:
+      <ul><li>We opted to skip the "Pay before you can play" mechanic</li>
+      <li>and rather went with the "Free to play but if you paid you are rewarded" mechanic</li>
+      <li>Players who bought the game from your website receive unlimited ammo and all weapons unlocked</li>
+      </ul>
+  </li>
+  </ul>
+</li>
+</ul>
+Use this demo to see how this was achieved and then apply it to your own projects.
+
+<hr>
+<h1>Installation and use</h1>
+<ol><li>Clone this project or download the zip and extract it somewhere you choose</li>
+<li>Create a new Unity project using Unity 2017.3 or later</li>
+<li>In the project settings make sure you select to use .NET4</li>
+<li>Install either <ul><li>"WordPress for Unity"</li><li> or "MBSCore" followed by "WordPress For Unity MBSCore Edition"</li></ul></li>
+<li>Move all the source files from this project into your project</li>
+<li>Add the Unity scenes included in this project to your project's build settings</li>
+<li>Enjoy</li></ol>