Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaronontheweb committed Mar 18, 2015
1 parent 73cb692 commit cc14527
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# DedicatedThreadPool
An instanced, dedicated thread pool for eliminating "noisy neighbor" problems on the CLR `ThreadPool`.

## Installation

You can install `DedicatedThreadPool` via NuGet!

```
PS> Install-package Helios.DedicatedThreadPool
```

This package doesn't install any binaries, just the following C# file: `Helios.Concurrency.DedicatedThreadPool.cs` - which contains the `DedicatedThreadPool`, `DedicatedThreadPoolTaskScheduler`, and `DedicatedThreadPoolSettings` classes.

## API

You can create a `Helios.Concurrency.DedicatedThreadPool` instance via the following API:
Expand Down Expand Up @@ -29,4 +39,12 @@ var Factory = new TaskFactory(Scheduler);
});

task.Wait();
```
```

> NOTE: `DedicatedThreadPool` is marked as `internal` by default, so it can be used opaquely across many dependent projects.
## License

See [LICENSE](LICENSE) for details.

Copyright (C) 2015 Roger Alsing, Aaron Stannard

0 comments on commit cc14527

Please sign in to comment.