docs: Update readme

NCronJob-Dev · Mar 17, 2024 · 9f7772b · 9f7772b
1 parent 87323b8
commit 9f7772b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -68,3 +68,22 @@ builder.Services.AddCronJob<PrintHelloWorld>(options =>
 ```
 
 4. Run your application and see the magic happen
+
+## Triggering a instant job
+If the need arises and you want to trigger a job instantly, you can do so:
+```csharp
+public class MyService
+{
+  private readonly IInstantJobRegistry jobRegistry;
+
+  public MyService(IInstantJobRegistry jobRegistry)
+  {
+    this.jobRegistry = jobRegistry;
+  }
+
+  public void MyMethod()
+  {
+	jobRegistry.AddInstantJob<MyJob>("I am an optional parameter");
+  }
+}
+```
diff --git a/sample/NCronJobSample/Program.cs b/sample/NCronJobSample/Program.cs
@@ -31,7 +31,7 @@
     {
         instantJobRegistry.AddInstantJob<PrintHelloWorld>();
     })
-    .WithName("GetWeatherForecast")
+    .WithName("TriggerInstantJob")
     .WithOpenApi();
 
 app.Run();