From 8666d05f0601110c7e4bb711c284bdea398ba5fb Mon Sep 17 00:00:00 2001 From: Konrad Malawski Date: Tue, 5 Jul 2016 16:23:25 +0200 Subject: [PATCH] =doc Improve readme a bit, more links, and sections (#20889) * =doc Improve readme a bit, more links, and sections * Add link to issues * Update README.md * Update README.md * Update README.md --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 42 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 91e67226c3f..339887d4645 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -# Akka +Akka +==== -We believe that writing correct concurrent & distributed, resilient and elastic applications is too hard. Most of the time it's because we are using the wrong tools and the wrong level of abstraction. +We believe that writing correct concurrent & distributed, resilient and elastic applications is too hard. +Most of the time it's because we are using the wrong tools and the wrong level of abstraction. Akka is here to change that. @@ -10,10 +12,44 @@ For resilience we adopt the "Let it crash" model which the telecom industry has Actors also provide the abstraction for transparent distribution and the basis for truly scalable and fault-tolerant applications. -Akka is Open Source and available under the Apache 2 License. +Learn more at [akka.io](http://akka.io/). + +Reference Documentation +----------------------- + +The reference documentation is available at [doc.akka.io](http://doc.akka.io), +for [Scala](http://doc.akka.io/docs/akka/current/scala.html) and [Java](http://doc.akka.io/docs/akka/current/scala.html). + + +Community +--------- +You can join these groups and chats to discuss and ask Akka related questions: + +- Mailing list: [![google groups: akka-user](https://img.shields.io/badge/group%3A-akka--user-blue.svg?style=flat-square)](https://groups.google.com/forum/#!forum/akka-user) +- Chat room about *using* Akka: [![gitter: akka/akka](https://img.shields.io/badge/gitter%3A-akka%2Fakka-blue.svg?style=flat-square)](https://gitter.im/akka/akka) +- Issue tracker: [![github: akka/akka](https://img.shields.io/badge/github%3A-issues-blue.svg?style=flat-square)](https://github.com/akka/akka/issues) + +In addition to that, you may enjoy following: -Learn more at [akka.io](http://akka.io/). Join the [akka-user](https://groups.google.com/forum/#!forum/akka-user) mailing list. Follow [@akkateam](https://twitter.com/akkateam) on twitter. +- The [Akka Team Blog](http://blog.akka.io) +- [@akkateam](https://twitter.com/akkateam) on Twitter +- Questions tagged [#akka on StackOverflow](stackoverflow.com/questions/tagged/akka) -If you are looking to contribute back to Akka, the [CONTRIBUTING.md](CONTRIBUTING.md) file should provide you with all the information needed to get started. +Contributing +------------ +Contributions are *very* welcome! -[![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/akka/akka?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) +If you see an issue that you'd like to see fixed, the best way to make it happen is to help out by submitting a PullRequest implementing it. + +Refer to the [CONTRIBUTING.md](https://github.com/akka/akka/blob/master/CONTRIBUTING.md) file for more details about the workflow, +and general hints how to prepare your pull request. You can also chat ask for clarifications or guidance in github issues directly, +or in the akka/dev chat if a more real time communication would be of benefit. + +A chat room is available for all questions related to *developing and contributing* to Akka: +[![gitter: akka/dev](https://img.shields.io/badge/gitter%3A-akka%2Fdev-blue.svg?style=flat-square)](https://gitter.im/akka/dev) + + +License +------- + +Akka is Open Source and available under the Apache 2 License.