Skip to content

Commit ffb4647

Browse files
authored
Nhse o32 or.i17 readme (#30)
Update to clarify on OTP version, and channels for comms and queries
1 parent 1728625 commit ffb4647

File tree

1 file changed

+22
-20
lines changed

1 file changed

+22
-20
lines changed

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,45 @@
22

33
![Riak Core OpenRiak Status](https://github.com/OpenRiak/riak_core/actions/workflows/erlang.yml/badge.svg?branch=openriak-3.2)
44

5-
Riak Core is the distributed systems framework that forms the basis of
6-
how [Riak](https://github.com/OpenRiak/riak) distributes data and scales.
7-
More generally, it can be thought of as a toolkit for building
8-
distributed, scalable, fault-tolerant applications.
5+
Riak Core is the distributed systems framework that forms the basis of how [Riak](https://github.com/OpenRiak/riak) distributes data and scales.
6+
More generally, it can be thought of as a toolkit for building distributed, scalable, fault-tolerant applications.
97

10-
For some introductory reading on Riak Core (that’s not pure code),
11-
there’s an old but still valuable
12-
[blog post on the Basho Blog](http://basho.com/where-to-start-with-riak-core/)
13-
that’s well worth your time.
8+
For some introductory reading on Riak Core (that’s not pure code), there’s an old but still valuable [blog post on the Basho Blog](http://basho.com/where-to-start-with-riak-core/) that’s well worth your time.
149

15-
This repository retains the history of the original [Basho repository](https://github.com/basho/riak_core/),
16-
but is no longer forked from it as the OpenRiak version evolves.
10+
This repository retains the history of the original [Basho repository](https://github.com/basho/riak_core/), but is no longer forked from it as the OpenRiak version evolves.
1711

1812
The prior OpenRiak [fork](https://github.com/OpenRiak/riak_core-forked) is retained for historical purposes.
1913

14+
The [riak_core_lite](https://riak-core-lite.github.io/) project also provides a modernised alternative to Riak Core targeted at those intending to build non-Riak applications on a riak_core-like platform.
15+
16+
## OTP version support
17+
18+
Riak is built on top of the [Erlang/OTP platform](https://github.com/erlang/otp). Supported versions for this release are:
19+
20+
![OTP Recommended](https://img.shields.io/badge/OTP_Recommended_Version-_OTP_24_-blue)
21+
22+
For later OTP versions, an alternative `openriak-<release>` branch will be required e.g. [`openriak-3.4` for OTP 26](https://github.com/OpenRiak/riak_core/tree/openriak-3.4). See [the roadmap discussion](https://github.com/orgs/OpenRiak/discussions/19) for further details.
23+
2024
## Contributing
2125

2226
We love community code, bug fixes, and other forms of contribution. We
2327
use GitHub Issues and Pull Requests for contributions to this and all
2428
other code. To get started:
2529

2630
1. Fork this repository.
27-
2. Clone your fork or add the remote if you already have a clone of
28-
the repository.
31+
2. Clone your fork or add the remote if you already have a clone of the repository.
2932
3. Create a topic branch for your change.
30-
4. Make your change and commit. Use a clear and descriptive commit
31-
message, spanning multiple lines if detailed explanation is needed.
33+
4. Make your change and commit. Use a clear and descriptive commit message, spanning multiple lines if detailed explanation is needed.
3234
5. Push to your fork of the repository and then send a pull request.
33-
6. An OpenRiak maintainer will review your patch and merge it into the main
34-
repository or send you feedback.
35+
6. An OpenRiak maintainer will review your patch and merge it into the main repository or send you feedback.
3536

3637
## Issues, Questions, and Bugs
3738

3839
There are numerous ways to file issues or start conversations around
3940
something Core related.
4041

41-
* The [Riak Slack](https://postriak.slack.com) community is often the quickest place to get answers to Riak and Core questions.
42-
* Riak Core development initiatives are located in this repo's [discussions](https://github.com/OpenRiak/riak_core/discussions) section.
43-
* Known issues are discussed in this repo's [issues](https://github.com/OpenRiak/riak_core/issues) section.
44-
* If you've found a bug in Riak Core, please [file](https://github.com/OpenRiak/riak_core/issues) a clear, concise, explanatory issue against this repo.
42+
- There is an `open-riak` group on the [Slack channel for the Erlang Ecosystem Foundation](https://erlef.org/slack-invite/erlef), where ad-hoc discussions on riak development take place.
43+
- The [Riak Slack](https://postriak.slack.com) is also available for Riak and Core questions.
44+
- Riak Core development initiatives are located in this repo's [discussions](https://github.com/OpenRiak/riak_core/discussions) section, or [the organisation discussion board](https://github.com/orgs/OpenRiak/discussions).
45+
- Known issues are discussed in this repo's [issues](https://github.com/OpenRiak/riak_core/issues) section.
46+
- If you've found a bug in Riak Core, please [file](https://github.com/OpenRiak/riak_core/issues) a clear, concise, explanatory issue against this repo.

0 commit comments

Comments
 (0)