Skip to content

Commit

Permalink
Update and fix readme (akkadotnet#3910)
Browse files Browse the repository at this point in the history 
* added updated README file

* added .NET Foundation logo
  • Loading branch information
@Aaronontheweb
Aaronontheweb authored Sep 10, 2019
1 parent 000d340 commit bded491
Show file tree
Hide file tree
Showing 2 changed files with 167 additions and 35 deletions.
60 changes: 25 additions & 35 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,27 +4,29 @@

[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/akkadotnet/akka.net?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) <br/>

## Builds status
||Windows|Linux (Mono)|
|:--:|:--:|:--:|
|Build|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_AkkaNetWindowsBuild/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_AkkaNetWindowsBuild&guest=1)|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_LinuxMonoBuild/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_LinuxMonoBuild&guest=1)|
|Unit Tests|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_AkkaNetWindowsUnitTests/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_AkkaNetWindowsUnitTests&guest=1)|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_AkkaNetLinuxMonoUnitTests/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_AkkaNetLinuxMonoUnitTests&guest=1)|
|MultiNode Tests|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_AkkaNetWindowsMultiNodeTests/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_AkkaNetWindowsMultiNodeTests&guest=1)|
|Perf Tests|[![Build status](http://petabridge-ci.cloudapp.net/app/rest/builds/buildType:AkkaNet_AkkaNetWindowsPerformanceTests/statusIcon)](http://petabridge-ci.cloudapp.net/viewType.html?buildTypeId=AkkaNet_AkkaNetWindowsPerformanceTests&guest=1)||
**Akka.NET** is a professional-grade port of the popular Java/Scala framework [Akka](http://akka.io) distributed actor framework to .NET.

## [Akka.NET Current Roadmap](https://petabridge.com/blog/akkadotnet-2016-roadmap/)
Akka.NET is a [.NET Foundation](https://dotnetfoundation.org/) project.

**Akka.NET** is a community-driven port of the popular Java/Scala framework [Akka](http://akka.io) to .NET.
![.NET Foundation Logo](docs/images/dotnetfoundationhorizontal.svg)

## Build Status


| Build | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=Windows%20Build)](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
|------------------------------------- |------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| NuGet Pack | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=NuGet%20Pack)](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Framework Unit Tests | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=.NET%20Framework%20Unit%20Tests%20(Windows))](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Framework MultiNode Tests | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=.NET%20Framework%20Multi-Node%20Tests%20(Windows))](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Core (Windows) Unit Tests | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=.NET%20Core%20Unit%20Tests%20(Windows))](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Core (Linux) Unit Tests | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=.NET%20Core%20Unit%20Tests%20(Linux))](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Core (Windows) MultiNode Tests | [![Build Status](https://dev.azure.com/dotnet/Akka.NET/_apis/build/status/akka.net/PR%20Validation?branchName=dev&jobName=.NET%20Core%20Multi-Node%20Tests%20(Windows))](https://dev.azure.com/dotnet/Akka.NET/_build/latest?definitionId=84&branchName=dev) |
| .NET Core (Linux) MultiNode Tests | |

* Subscribe to the Akka.NET dev feed: https://twitter.com/AkkaDotNet (@AkkaDotNet)
* Gitter chat: https://gitter.im/akkadotnet/akka.net
* Support forum: https://groups.google.com/forum/#!forum/akkadotnet-user-list
* Mail: [email protected]
* Stack Overflow: http://stackoverflow.com/questions/tagged/akka.net

### Documentation and resources

#### [Akka.NET Community Site](http://getakka.net)
#### [Akka.NET Project Site](http://getakka.net)


### Install Akka.NET via NuGet
Expand All @@ -44,28 +46,16 @@ And if you need F# support:
PM> Install-Package Akka.FSharp
```

### Contributing
#### Where Can I Contribute?

[![Critical Issues](https://badge.waffle.io/akkadotnet/akka.net.svg?label=help%20wanted&title=Issues%20Needing%20Help%20Now!)](http://waffle.io/akkadotnet/akka.net)
<br>
[![Stories Up For Grabs](https://badge.waffle.io/akkadotnet/akka.net.svg?label=up%20for%20grabs&title=General%20Issues%20Up%20For%20Grabs)](http://waffle.io/akkadotnet/akka.net)

> *All contributions are welcome! Please consider the [issues categorized in the `Help!` column](http://waffle.io/akkadotnet/akka.net) first, as they are areas we could really use your help :)*
#### Contribution Guidelines
If you are interested in helping porting Akka to .NET please take a look at [Contributing to Akka.NET](http://getakka.net/community/contributor-guidelines.html).

Our [docs](http://getakka.net/articles/intro/what-is-akka.html) are always a work in progress—to contribute to docs, please see the [docs contribution guidelines here](http://getakka.net/community/documentation-guidelines.html).


#### Builds
## Builds
Please see [Building Akka.NET](http://getakka.net/community/building-akka-net.html).

To access unstable nightly builds, please [see the instructions here](http://getakka.net/community/getting-access-to-nightly-builds.html).
To access nightly Akka.NET builds, please [see the instructions here](http://getakka.net/community/getting-access-to-nightly-builds.html).

### Support
<a href="http://www.jetbrains.com/resharper"><img src="http://i61.tinypic.com/15qvwj7.jpg" alt="ReSharper" title="ReSharper"></a>
## Support
If you need help getting started with Akka.NET, there's a number of great community resources online:

<a href="https://www.jetbrains.com/teamcity/"><img src="http://i59.tinypic.com/2hmiirp.gif" alt="TeamCity" title="TeamCity"></a>
* Subscribe to the Akka.NET project feed on Twitter: https://twitter.com/AkkaDotNet (@AkkaDotNet)
* Join the Akka.NET project Gitter chat: https://gitter.im/akkadotnet/akka.net
* Ask Akka.NET questions on Stack Overflow: http://stackoverflow.com/questions/tagged/akka.net

If you and your company are interested in getting professional Akka.NET support, you can [contact Petabridge for dedicated Akka.NET support](https://petabridge.com/).
142 changes: 142 additions & 0 deletions docs/images/dotnetfoundationhorizontal.svg
View file
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 bded491

Please sign in to comment.