-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added package license, readme, logo, et al (#17)
- Loading branch information
1 parent
15e064e
commit 4e97244
Showing
3 changed files
with
53 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,43 @@ | ||
# akkadotnet-templates | ||
Production-ready dotnet new templates for Akka.NET. | ||
|
||
 | ||
|
||
Production-ready `dotnet new` templates for [Akka.NET](https://getakka.net/). | ||
|
||
All of these templates are designed to be simple and provide you with a relatively complete structure to get started developing your own Akka.NET applications from scratch. | ||
|
||
**Upon installing these templates via the `dotnet` CLI, you will have access to them from both the `dotnet` CLI itself and any .NET IDE - such as Visual Studio and JetBrains Rider!** | ||
|
||
## Installation | ||
|
||
To install these templates, just install the `Akka.Templates` package from NuGet: | ||
|
||
```shell | ||
dotnet new -i "Akka.Templates::*" | ||
``` | ||
|
||
To upgrade these templates to a newer version: | ||
|
||
```shell | ||
dotnet new update | ||
``` | ||
|
||
To uninstall these templates from your local machine: | ||
|
||
|
||
```shell | ||
dotnet new -u Akka.Templates | ||
``` | ||
|
||
## Available Templates | ||
|
||
The following templates are available as part of the `Akka.Templates` package: | ||
|
||
| Template | Short Name | Description | | ||
|-------------|------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | ||
| [Akka.WebApi](https://github.com/akkadotnet/akkadotnet-templates/blob/dev/docs/WebApiTemplate.md) | akkawebapi | A template for building ASP.NET HTTP APIs on top of an Akka.NET Cluster. Uses Akka.Cluster.Sharding and, optionally: Akka.Management + Akka.Persistence.Azure + Akka.Azure.Discovery. This template is meant as a starter for building distributed systems with Akka.NET | | ||
|
||
See [the official `dotnet new` documentation](https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet-new) for more information on the sorts of options that are available when using project templates. | ||
|
||
## Questions, Comments, and Suggestions | ||
We accept pull requests! Please let us know what we can do to make these templates more useful, extensible, or easier to use. |