Update README for v1.6.0

merge-requests/2/head
Mike Koch 10 years ago
parent 2d7bfaf3d2
commit 1df1dfab48

@ -1,7 +1,7 @@
[![Stories in Ready](https://badge.waffle.io/mkoch227/Mods-For-Hesk.png?label=waffle:ready&title=Ready)](https://waffle.io/mkoch227/Mods-For-Hesk)
<h2><a href="http://numods.mkochcs.com" target="_blank">NuMods</a> v1.5.0</h2>
<h2><a href="http://mods-for-hesk.mkochcs.com" target="_blank">Mods for Hesk</a> v1.6.0</h2>
This branch contains all files modified from the base version of HESK to become NuMods, a set of modifications for HESK v2.x
Mods for Hesk is a set of modifications for HESK v2.5.5, a free and popular helpdesk solution.
<h2>Features</h2>
<ul>
@ -18,11 +18,11 @@ This branch contains all files modified from the base version of HESK to become
<h2>Download</h2>
You can download this mod via two ways:
You can download Mods for Hesk via two ways:
<ol>
<li><strong>Stable Releases:</strong> Releases that have a release tag associated with a commit are considered releases. You can click on "releases" on the top of the repo, and then click "zip" or "tar.gz" to download the repo at that stage.</li>
<li><strong>Bleeding-edge Releases:</strong> You can also download the latest, bleeding-edge version of NuMods by simply clicking "download as zip" to the right of the repository. This will download an exact copy of this branch in its current state, which may be contain bugs/other issues. This is not recommended for a production use.</li>
<li><strong>Bleeding-edge Releases:</strong> You can also download the latest, bleeding-edge version of Mods for Hesk by simply clicking "download as zip" to the right of the repository. This will download an exact copy of this branch in its current state, which may be contain bugs/other issues. This is not recommended for a production use.</li>
</ol>
<h2>Installation</h2>
@ -30,18 +30,18 @@ You can download this mod via two ways:
<ol>
<li>Download HESK from <a href="http://www.hesk.com/download.php" target="_blank">http://www.hesk.com/download.php</a>.</li>
<li>Extract the contents of HESK to a directory of your choice.</li>
<li>Download NuMods from one of the two methods described above.</li>
<li>Download Mods for Hesk from one of the two methods described above.</li>
<li>Copy and paste the contents of the zip/tar.gz bundle and overwrite any files in the original HESK 2.x folder.</li>
<li>Upload the resulting folder to your webserver.</li>
<li>Go to the /install directory in your web browser and click on "Install/Update NuMods Installation"</li>
<li>Go to the /install directory in your web browser and click on "Install/Update Mods for Hesk Installation"</li>
</ol>
<p>Please consult the official HESK Documentation on how to install HESK, as it is the same for both HESK and NuMods.</p>
<p>Please consult the official HESK Documentation on how to install HESK, as it is the same for both HESK and Mods for Hesk.</p>
<h2>Languages</h2>
<p>As of current, only English is a supported language, as there have been several language items that have been edited/created. If you want to translate NuMods to your own language, it is recommended to download the original HESK language file for your language, and then add/edit the lines listed under <code>//Added or modified in HESK UI</code> and <code>//Added or modified in NuMods X.X.X</code> (where X.X.X is a version number) for your language.</p>
<p>NuMods translations are available at <a href="http://numods.mkochcs.com/download.php" target="_blank">http://numods.mkochcs.com/download.php</a>.</p>
<p>As of current, only English is a supported language, as there have been several language items that have been edited/created. If you want to translate Mods for Hesk to your own language, it is recommended to download the original HESK language file for your language, and then add/edit the lines listed under <code>//Added or modified in Mods for Hesk X.X.X (where X.X.X is a version number) for your language.</p>
<p>Mods for Hesk translations are available at <a href="http://mods-for-hesk.mkochcs.com/download.php" target="_blank">http://mods-for-hesk.mkochcs.com/download.php</a>.</p>
<h2>Browser Compability</h2>
<h2>Browser Compatibility</h2>
<p>This list may be incomplete. Please leave a note on the PHP Junkyard forums for additional browser compatibility information.
<ul>
<li><strong>Google Chrome 33+: </strong> Compatible</li>
@ -50,10 +50,10 @@ You can download this mod via two ways:
<li><strong>Internet Explorer 8:</strong> Partial Compatibility</li>
<li><strong>Internet Explorer 9:</strong> Compatible</li>
</ul>
<p>There are no intentions of making NuMods compatible with Internet Explorer 6 or 7, or any browser that is 2 or more major revisions older than its latest version.</p>
<p>There are no intentions of making Mods for Hesk compatible with Internet Explorer 6 or 7, or any browser that is 2 or more major revisions older than its latest version.</p>
<h2>Versioning</h2>
<p>NuMods will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:</p>
<p>Mods for Hesk will be maintained under the Semantic Versioning guidelines as much as possible. Releases will be numbered with the following format:</p>
<code>&lt;major&gt;.&lt;minor&gt;.&lt;patch&gt;</code>
@ -68,5 +68,5 @@ You can download this mod via two ways:
<p>For more information on SemVer, please visit http://semver.org.</p>
<h2>Credits</h2>
<p>Mike Koch - Creator of NuMods</p>
<p>Mike Koch - Creator of Mods for Hesk</p>
<p>Klemen Stirn - Creator of HESK</p>

Loading…
Cancel
Save