Skip to content

Commit 643b103

Browse files
committed
README Grammar Corrections
Lightweight proofreading of the README: fixing commas, some articles, a tense or two, etc.
1 parent 6b99013 commit 643b103

File tree

1 file changed

+28
-28
lines changed

1 file changed

+28
-28
lines changed

‎README.md‎

Lines changed: 28 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,21 @@ Hangfire
33

44
[![Official Site](https://img.shields.io/badge/site-hangfire.io-blue.svg)](http://hangfire.io) [![Latest version](https://img.shields.io/nuget/v/Hangfire.svg)](https://www.nuget.org/packages?q=hangfire) [![Build status](https://ci.appveyor.com/api/projects/status/70m632jkycqpnsp9?svg=true)](https://ci.appveyor.com/project/odinserj/hangfire-525) [![Build Status](https://travis-ci.org/HangfireIO/Hangfire.svg)](https://travis-ci.org/HangfireIO/Hangfire) [![License LGPLv3](https://img.shields.io/badge/license-LGPLv3-green.svg)](http://www.gnu.org/licenses/lgpl-3.0.html)
55

6-
Incredibly easy way to perform **fire-and-forget**, **delayed** and **recurring jobs** inside **ASP.NET applications**. CPU and I/O intensive, long-running and short-running jobs are supported. No Windows Service / Task Scheduler required. Backed by Redis, SQL Server, SQL Azure or MSMQ.
7-
8-
Hangfire provides unified programming model to handle background tasks in a **reliable way** and run them on shared hosting, dedicated hosting or in cloud. You can start with a simple setup and grow computational power for background jobs with time for these scenarios:
9-
10-
- mass notifications/newsletter;
11-
- batch import from xml, csv, json;
12-
- creation of archives;
13-
- firing off web hooks;
14-
- deleting users;
15-
- building different graphs;
16-
- image/video processing;
17-
- purge temporary files;
18-
- recurring automated reports;
19-
- database maintenance;
20-
- *…and so on.*
6+
Incredibly easy way to perform **fire-and-forget**, **delayed** and **recurring jobs** inside **ASP.NET applications**. CPU and I/O intensive, long-running and short-running jobs are supported. No Windows Service / Task Scheduler required. Backed by Redis, SQL Server, SQL Azure and MSMQ.
7+
8+
Hangfire provides a unified programming model to handle background tasks in a **reliable way** and run them on shared hosting, dedicated hosting or in cloud. You can start with a simple setup and grow computational power for background jobs with time for these scenarios:
9+
10+
- mass notifications/newsletters
11+
- batch import from xml, csv or json
12+
- creation of archives
13+
- firing off web hooks
14+
- deleting users
15+
- building different graphs
16+
- image/video processing
17+
- purging temporary files
18+
- recurring automated reports
19+
- database maintenance
20+
- *…and so on*
2121

2222
Hangfire is a .NET Framework alternative to [Resque](https://github.com/resque/resque), [Sidekiq](http://sidekiq.org), [delayed_job](https://github.com/collectiveidea/delayed_job), [Celery](http://www.celeryproject.org).
2323

@@ -26,13 +26,13 @@ Hangfire is a .NET Framework alternative to [Resque](https://github.com/resque/r
2626
Installation
2727
-------------
2828

29-
Hangfire is available as a NuGet package. So, you can install it using the NuGet Package Console window:
29+
Hangfire is available as a NuGet package. You can install it using the NuGet Package Console window:
3030

3131
```
3232
PM> Install-Package Hangfire
3333
```
3434

35-
After install, update your existing [OWIN Startup](http://www.asp.net/aspnet/overview/owin-and-katana/owin-startup-class-detection) file with the following lines of code. If you do not have this class in your project or don't know what is it, please read the [Quick start](http://docs.hangfire.io/en/latest/quickstart.html) guide to learn about how to install Hangfire.
35+
After installation, update your existing [OWIN Startup](http://www.asp.net/aspnet/overview/owin-and-katana/owin-startup-class-detection) file with the following lines of code. If you do not have this class in your project or don't know what is it, please read the [Quick start](http://docs.hangfire.io/en/latest/quickstart.html) guide to learn about how to install Hangfire.
3636

3737
```csharp
3838
public void Configuration(IAppBuilder app)
@@ -47,27 +47,27 @@ public void Configuration(IAppBuilder app)
4747
Usage
4848
------
4949

50-
This is incomplete list of features, to see all of them, check the [official site](http://hangfire.io) and the [documentation](http://docs.hangfire.io).
50+
This is an incomplete list of features; to see all of them, check the [official site](http://hangfire.io) and the [documentation](http://docs.hangfire.io).
5151

5252
[**Fire-and-forget tasks**](http://docs.hangfire.io/en/latest/users-guide/background-methods/calling-methods-in-background.html)
5353

54-
Enqueued background jobs are being executed inside a dedicated worker pool threads as soon as possible, shortening your request processing time.
54+
Dedicated worker pool threads execute queued background jobs as soon as possible, shortening your request's processing time.
5555

5656
```csharp
5757
BackgroundJob.Enqueue(() => Console.WriteLine("Simple!"));
5858
```
5959

6060
[**Delayed tasks**](http://docs.hangfire.io/en/latest/users-guide/background-methods/calling-methods-with-delay.html)
6161

62-
Scheduled background jobs are being executed only after given amount of time.
62+
Scheduled background jobs are executed only after a given amount of time.
6363

6464
```csharp
6565
BackgroundJob.Schedule(() => Console.WriteLine("Reliable!"), TimeSpan.FromDays(7));
6666
```
6767

6868
[**Recurring tasks**](http://docs.hangfire.io/en/latest/users-guide/background-methods/performing-recurrent-tasks.html)
6969

70-
Recurring jobs have never been simpler, just call the following method to perform any kind of recurring task using the [CRON expressions](http://en.wikipedia.org/wiki/Cron#CRON_expression).
70+
Recurring jobs have never been simpler; just call the following method to perform any kind of recurring task using the [CRON expressions](http://en.wikipedia.org/wiki/Cron#CRON_expression).
7171

7272
```csharp
7373
RecurringJob.AddOrUpdate(() => Console.WriteLine("Transparent!"), Cron.Daily);
@@ -82,17 +82,17 @@ var id = BackgroundJob.Enqueue(() => Console.WriteLine("Hello, "));
8282
BackgroundJob.ContinueWith(id, () => Console.WriteLine("world!"));
8383
```
8484

85-
**Process them inside a web application…**
85+
**Process background tasks inside a web application…**
8686

87-
You can process background tasks in any OWIN compatible application frameworks, including [ASP.NET MVC](http://www.asp.net/mvc), [ASP.NET Web API](http://www.asp.net/web-api), [FubuMvc](http://fubu-project.org), [Nancy](http://nancyfx.org), etc. Forget about [AppDomain unloads, Web Garden & Web Farm issues](http://haacked.com/archive/2011/10/16/the-dangers-of-implementing-recurring-background-tasks-in-asp-net.aspx/) – Hangfire is reliable for web applications from scratch, even on shared hosting.
87+
You can process background tasks in any OWIN-compatible application framework, including [ASP.NET MVC](http://www.asp.net/mvc), [ASP.NET Web API](http://www.asp.net/web-api), [FubuMvc](http://fubu-project.org), [Nancy](http://nancyfx.org), etc. Forget about [AppDomain unloads, Web Garden & Web Farm issues](http://haacked.com/archive/2011/10/16/the-dangers-of-implementing-recurring-background-tasks-in-asp-net.aspx/) – Hangfire is reliable for web applications from scratch, even on shared hosting.
8888

8989
```csharp
9090
app.UseHangfireServer();
9191
```
9292

9393
**… or anywhere else**
9494

95-
In console application, Windows Service, Azure Worker Role, etc.
95+
In console applications, Windows Service, Azure Worker Role, etc.
9696

9797
```csharp
9898
using (new BackgroundJobServer())
@@ -105,21 +105,21 @@ using (new BackgroundJobServer())
105105
Questions? Problems?
106106
---------------------
107107

108-
Open-source project are developing more smoothly, when all discussions are held in public.
108+
Open-source projects develop more smoothly when discussions are public.
109109

110-
If you have any questions, problems related to the Hangfire usage or want to discuss new features, please visit the [discussion forum](http://discuss.hangfire.io). You can sign in there using your existing Google or GitHub account, so it's very simple to start using it.
110+
If you have any questions, problems related to Hangfire usage or if you want to discuss new features, please visit the [discussion forum](http://discuss.hangfire.io). You can sign in there using your existing Google or GitHub account, so it's very simple to start using it.
111111

112112
If you've discovered a bug, please report it to the [Hangfire GitHub Issues](https://github.com/odinserj/Hangfire/issues?state=open). Detailed reports with stack traces, actual and expected behavours are welcome.
113113

114114
Related Projects
115115
-----------------
116116

117-
Please see the [Extensions](http://hangfire.io/extensions.html) page on official site.
117+
Please see the [Extensions](http://hangfire.io/extensions.html) page on the official site.
118118

119119
Building the sources
120120
---------------------
121121

122-
To build a solution and get assembly files, just run the following command. All build artifacts, including `*.pdb` files will be placed into the `build` folder. **Before proposing a pull request, please use this command to ensure everything is ok.** Btw, you can execute this command from Package Manager Console window.
122+
To build a solution and get assembly files, just run the following command. All build artifacts, including `*.pdb` files, will be placed into the `build` folder. **Before proposing a pull request, please use this command to ensure everything is ok.** Btw, you can execute this command from the Package Manager Console window.
123123

124124
```
125125
build

0 commit comments

Comments
 (0)