You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pekko.apache.org by fa...@apache.org on 2024/03/21 12:59:20 UTC
(incubator-pekko-projection) 01/01: expand README.md
This is an automated email from the ASF dual-hosted git repository.
fanningpj pushed a commit to branch pjfanning-patch-1
in repository https://gitbox.apache.org/repos/asf/incubator-pekko-projection.git
commit 7f558058cf75bb049321627f9ef6eaa51f34f219
Author: PJ Fanning <pj...@users.noreply.github.com>
AuthorDate: Thu Mar 21 13:59:13 2024 +0100
expand README.md
---
README.md | 23 +++++++++++++++++++++++
1 file changed, 23 insertions(+)
diff --git a/README.md b/README.md
index 8dd72ed..6fe6f06 100644
--- a/README.md
+++ b/README.md
@@ -4,3 +4,26 @@ Apache Pekko Projections provides an abstraction for consuming a stream of `Enve
or other Apache Pekko connectors.
Apache Pekko Projections also provides tools to track, restart and distribute these projections.
+
+## Documentation
+
+Apache Pekko Projections are documented at https://pekko.apache.org/docs/pekko-projection/current/.
+
+To keep up with the latest releases check out [Pekko Projections releases](https://pekko.apache.org/docs/pekko-projection/current/release-notes.html).
+
+## Community
+
+You can join these forums and chats to discuss and ask Pekko and Pekko connector related questions:
+
+- [GitHub discussions](https://github.com/apache/incubator-pekko-projection/discussions): for questions and general discussion.
+- [Pekko users mailing list](https://lists.apache.org/list.html?users@pekko.apache.org): for Pekko usage discussions.
+- [Pekko dev mailing list](https://lists.apache.org/list.html?dev@pekko.apache.org): for Pekko development discussions.
+- [GitHub issues](https://github.com/apache/incubator-pekko-projection/issues): for bug reports and feature requests. Please search the existing issues before creating new ones. If you are unsure whether you have found a bug, consider asking in GitHub discussions or the mailing list first.
+
+## Contributing
+
+Contributions are very welcome. If you have an idea on how to improve Pekko, don't hesitate to create an issue or submit a pull request.
+
+## License
+
+Apache Pekko Projections is available under the Apache License, version 2.0. See [LICENSE](https://github.com/apache/incubator-pekko-projection/blob/main/LICENSE) file for details.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@pekko.apache.org
For additional commands, e-mail: commits-help@pekko.apache.org