Skip to content

Commit

Permalink
added package license, readme, logo, et al (#17)
Browse files Browse the repository at this point in the history
  • Loading branch information
Aaronontheweb authored Mar 16, 2023
1 parent 15e064e commit 4e97244
Show file tree
Hide file tree
Showing 3 changed files with 53 additions and 4 deletions.
14 changes: 11 additions & 3 deletions Akka.Templates.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,27 @@
<Authors>AkkaDotNet</Authors>
<Description>Templates to use when creating new Akka.NET applications.</Description>
<PackageTags>dotnet-new;templates;akkadotnet;akka;</PackageTags>

<TargetFramework>netstandard2.0</TargetFramework>

<IncludeContentInPack>true</IncludeContentInPack>
<IncludeBuildOutput>false</IncludeBuildOutput>
<ContentTargetFolders>content</ContentTargetFolders>
<NoWarn>$(NoWarn);NU5128</NoWarn>
<NoDefaultExcludes>true</NoDefaultExcludes>
<PackageIcon>logo.png</PackageIcon>
<PackageProjectUrl>https://github.com/akkadotnet/akkadotnet-templates</PackageProjectUrl>
<PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
<NoWarn>$(NoWarn);CS1591;xUnit1013</NoWarn>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
<Content Include="src\**\*" Exclude="src\**\bin\**;src\**\obj\**" />
<Compile Remove="**\*" />
</ItemGroup>

</Project>
<ItemGroup>
<None Include="$(MSBuildThisFileDirectory)\logo.png" Pack="true" Visible="false" PackagePath="\" />
<None Include="$(MSBuildThisFileDirectory)\README.md" Pack="true" Visible="false" PackagePath="\" />
</ItemGroup>

</Project>
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,43 @@
# akkadotnet-templates
Production-ready dotnet new templates for Akka.NET.

![Akka.NET logo](icon.png)

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.
Binary file added logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4e97244

Please sign in to comment.