Merge branch 'master' of https://github.com/jrbudda/KerbalEngineer

jrbudda · Dec 20, 2018 · 75d5e43 · 75d5e43
2 parents 1f530a5 + 7fe2181
commit 75d5e43
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 20 deletions.
diff --git a/Documents/README.htm b/Documents/README.htm
@@ -117,12 +117,13 @@
 </head>
 <body>
 	<div id='root'>
-		<header>Kerbal Engineer Redux v1.0</header>
+		<header>Kerbal Engineer Redux</header>
 
 		<section>
 			<h3>Developers</h3>
 			<p>
-				CYBUTEK: Primary Development<br>
+				jrbudda: Taken over primary development from CYBUTEK
+				CYBUTEK: Original developer<br>
 				Padishar: Simulation Logic
 			</p>
 		</section>
@@ -134,32 +135,19 @@ <h3>Honourable Mentions</h3>
 			</p>
 		</section>
 
-		<section>
-			<h3>Goto the Forum Thread</h3>
-			<p>
-				<a href="http://forum.kerbalspaceprogram.com/threads/18230" target='_blank'>http://forum.kerbalspaceprogram.com/threads/18230</a>
-			</p>
-		</section>
-
 		<section>
 			<h3>KSP-AVC Ready</h3>
 			<p>
-				KSP Add-on Version Checker is a standardised system for versioning mods. You can get more information on this
-				<a href='http://forum.kerbalspaceprogram.com/threads/79745' target='_blank'>forum thread</a>.
-			</p>
-		</section>
-
-		<section>
-			<h3>Contains MiniAVC</h3>
-			<p>
-				This mod includes version checking using <a href="http://forum.kerbalspaceprogram.com/threads/79745">MiniAVC</a>. If you opt-in, it will use the internet to check whether there is a new version available. Data is only read from the internet and no personal information is sent. For a more comprehensive version checking experience, please download the <a href="http://forum.kerbalspaceprogram.com/threads/79745">KSP-AVC Plugin</a>. 
+				KSP Add-on Version Checker is a standardised system for versioning mods. More info and the source code can be found at can be found at:
+				<a href='https://github.com/CYBUTEK/KSPAddonVersionChecker' target='_blank'>GitHub repository</a>.
 			</p>
 		</section>
 
 		<section>
 			<h3>Description</h3>
 			<p>
-				This plugin will allow you to view important statistics about your ship on the fly, whilst constructing and in flight.
+				This plugin will allow you to view important statistics about your ship and it's orbit during both flight, building and in the tracking station.
+				These statistics help you plan and execute your missions with greater accuracy.
 			</p>
 		</section>
 
@@ -190,4 +178,4 @@ <h3>Software License</h3>
 		README design by <a href='http://ksp.cybutek.net' target='_blank'><strong>CYBUTEK</strong></a> (GPLv3)
 	</footer>
 </body>
-</html>
+</html>
diff --git a/README.md b/README.md
@@ -0,0 +1,19 @@
+# Kerbal Engineer Redux
+
+KER is a mod for Kerbal Space Program with tools for viewing important statistics about your ship and it's orbit during both flight, building and in the tracking station.
+These statistics help you plan and execute your missions with greater accuracy.
+
+## Download
+
+[Latest release](https://github.com/jrbudda/KerbalEngineer/releases/latest)
+
+[Browse releases](https://github.com/jrbudda/KerbalEngineer/releases)
+
+## Installing
+
+1. Firstly download the latest ZIP-file and uncompress it.
+2. Then simply put your KerbalEngineer folder in the GameData folder that's inside the game folder for Kerbal Space Program.
+
+## Special thanks to
+
+[CYBUTEK](https://github.com/CYBUTEK), the original developer of KER