Skip to content

Commit c955463

Browse files
committed
Update docs site
1 parent 30e6444 commit c955463

File tree

7 files changed

+95
-3
lines changed

7 files changed

+95
-3
lines changed
File renamed without changes.
File renamed without changes.

docs/css/style.css

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
.navbar-default {
2+
background: #2f2f2f;
3+
}
4+
5+
.navbar-default .navbar-nav > .active > a,
6+
.navbar-default .navbar-nav > .active > a:hover,
7+
.navbar-default .navbar-nav > .active > a:focus {
8+
background-color: #0f0f0f;
9+
}
10+
11+
.navbar-default .navbar-nav > li > a:hover,
12+
.navbar-default .navbar-nav > li > a:focus {
13+
background-color: #0f0f0f;
14+
}
15+
16+
a,
17+
a:hover,
18+
a:focus {
19+
color: #2200CC;
20+
}
21+

docs/images/inengine-header.png

10 KB
Loading
746 Bytes
Loading

docs/index.html

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,11 +64,67 @@
6464
<div class="container">
6565
<div class="col-md-3"><div class="bs-sidebar hidden-print affix well" role="complementary">
6666
<ul class="nav bs-sidenav">
67+
<li class="main active"><a href="#what-is-this">What is this?</a></li>
68+
<li><a href="#install">Install</a></li>
69+
<li><a href="#create-a-command">Create a Command</a></li>
6770
</ul>
6871
</div></div>
6972
<div class="col-md-9" role="main">
7073

71-
</div>
74+
<h1 id="what-is-this">What is this?</h1>
75+
<p>InEngine.NET is a background commands processing server.
76+
It allows commands to be queued, scheduled, and ran directly. </p>
77+
<h2 id="install">Install</h2>
78+
<p>First, install the InEngine.Core package into your own Visual Studio project.</p>
79+
<p><strong>Package Manager</strong></p>
80+
<pre><code class="bash">Install-Package InEngine.Core
81+
</code></pre>
82+
83+
<p><strong>Nuget CLI</strong></p>
84+
<pre><code class="bash">nuget install InEgine.Core
85+
</code></pre>
86+
87+
<p><strong>.NET CLI</strong></p>
88+
<pre><code class="bash">dotnet add package InEngine.Core
89+
</code></pre>
90+
91+
<p><strong>Paket CLI</strong></p>
92+
<pre><code class="bash">paket add InEngine.Core
93+
</code></pre>
94+
95+
<p>Second, download the CLI and/or the Scheduler from a release that matches the version of the InEngine.Core package you included.</p>
96+
<p>Releases are found on GitHub: https://github.com/InEngine-NET/InEngine.NET/releases</p>
97+
<h2 id="create-a-command">Create a Command</h2>
98+
<p>Add a class that implements <strong>InEngine.Core.ICommand</strong> or extends <strong>InEngine.Core.AbstractCommand</strong>. </p>
99+
<pre><code class="c#">using InEngine.Core;
100+
101+
namespace MyCommands
102+
{
103+
public class MyCommand : ICommand
104+
{
105+
public CommandResult Run()
106+
{
107+
return new CommandResult(true);
108+
}
109+
}
110+
}
111+
</code></pre>
112+
113+
<p>The <strong>AbstractCommand</strong> class adds extra functionality, like a logger, a progress bar, and the ability to schedule the command using the scheduler.
114+
Minimally, the Run method should be overridden.</p>
115+
<pre><code class="c#">using InEngine.Core;
116+
117+
namespace MyCommands
118+
{
119+
public class MyCommand : AbstractCommand
120+
{
121+
public override CommandResult Run()
122+
{
123+
return new CommandResult(true);
124+
}
125+
}
126+
}
127+
</code></pre></div>
72128
</div>
73129

74130
<footer class="col-md-12">
@@ -108,5 +164,5 @@ <h4 class="modal-title" id="exampleModalLabel">Search</h4>
108164

109165
<!--
110166
MkDocs version : 0.16.3
111-
Build Date UTC : 2017-11-19 21:16:33
167+
Build Date UTC : 2017-11-19 21:51:27
112168
-->

docs/mkdocs/search_index.json

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,23 @@
22
"docs": [
33
{
44
"location": "/",
5-
"text": "",
5+
"text": "What is this?\n\n\nInEngine.NET is a background commands processing server. \nIt allows commands to be queued, scheduled, and ran directly. \n\n\nInstall\n\n\nFirst, install the InEngine.Core package into your own Visual Studio project.\n\n\nPackage Manager\n\n\nInstall-Package InEngine.Core\n\n\n\n\nNuget CLI\n\n\nnuget install InEgine.Core\n\n\n\n\n.NET CLI\n\n\ndotnet add package InEngine.Core\n\n\n\n\nPaket CLI\n\n\npaket add InEngine.Core\n\n\n\n\nSecond, download the CLI and/or the Scheduler from a release that matches the version of the InEngine.Core package you included.\n\n\nReleases are found on GitHub: https://github.com/InEngine-NET/InEngine.NET/releases\n\n\nCreate a Command\n\n\nAdd a class that implements \nInEngine.Core.ICommand\n or extends \nInEngine.Core.AbstractCommand\n. \n\n\nusing InEngine.Core;\n\nnamespace MyCommands\n{\n public class MyCommand : ICommand\n {\n public CommandResult Run()\n {\n return new CommandResult(true);\n }\n }\n}\n\n\n\n\nThe \nAbstractCommand\n class adds extra functionality, like a logger, a progress bar, and the ability to schedule the command using the scheduler.\nMinimally, the Run method should be overridden.\n\n\nusing InEngine.Core;\n\nnamespace MyCommands\n{\n public class MyCommand : AbstractCommand\n {\n public override CommandResult Run()\n {\n return new CommandResult(true);\n }\n }\n}",
66
"title": "Getting Started"
7+
},
8+
{
9+
"location": "/#what-is-this",
10+
"text": "InEngine.NET is a background commands processing server. \nIt allows commands to be queued, scheduled, and ran directly.",
11+
"title": "What is this?"
12+
},
13+
{
14+
"location": "/#install",
15+
"text": "First, install the InEngine.Core package into your own Visual Studio project. Package Manager Install-Package InEngine.Core Nuget CLI nuget install InEgine.Core .NET CLI dotnet add package InEngine.Core Paket CLI paket add InEngine.Core Second, download the CLI and/or the Scheduler from a release that matches the version of the InEngine.Core package you included. Releases are found on GitHub: https://github.com/InEngine-NET/InEngine.NET/releases",
16+
"title": "Install"
17+
},
18+
{
19+
"location": "/#create-a-command",
20+
"text": "Add a class that implements InEngine.Core.ICommand or extends InEngine.Core.AbstractCommand . using InEngine.Core;\n\nnamespace MyCommands\n{\n public class MyCommand : ICommand\n {\n public CommandResult Run()\n {\n return new CommandResult(true);\n }\n }\n} The AbstractCommand class adds extra functionality, like a logger, a progress bar, and the ability to schedule the command using the scheduler.\nMinimally, the Run method should be overridden. using InEngine.Core;\n\nnamespace MyCommands\n{\n public class MyCommand : AbstractCommand\n {\n public override CommandResult Run()\n {\n return new CommandResult(true);\n }\n }\n}",
21+
"title": "Create a Command"
722
}
823
]
924
}

0 commit comments

Comments
 (0)