This is an automated email from the ASF dual-hosted git repository.
jmark99 pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/accumulo-examples.git
The following commit(s) were added to refs/heads/main by this push:
new 3d5e01d Update README.md to clarify use of 'main' vs '2.0' branch
(#102)
3d5e01d is described below
commit 3d5e01d445604a7fc4efaa90c7068bac83ce2919
Author: Mark Owens <jmar...@apache.org>
AuthorDate: Wed Apr 27 10:23:52 2022 -0400
Update README.md to clarify use of 'main' vs '2.0' branch (#102)
Added additional information to the README to clarify the distinction
between the 'main' branch and additional branches.
Indicate use of 'main' branch as examples for current development
version of Accumulo while each release of Accumulo will have its own
separate branch.
Also, added link to 1.10 examples.
Closes #80
---
README.md | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/README.md b/README.md
index 98d044a..7637ce7 100644
--- a/README.md
+++ b/README.md
@@ -18,6 +18,15 @@ limitations under the License.
[![Build Status][ti]][tl]
+## Introduction
+
+The Accumulo-Examples repository contains a collection of examples for
Accumulo versions 2.0 and
+greater. Examples within the `main` branch are designed to work with the
version currently
+under development. Additional branches exist for previous releases of the
Accumulo 2.x line. For
+example, the `2.0` branch contains examples specifically intended to work with
that release version.
+
+A collection of examples for Accumulo 1.10 can be found [here].
+
## Setup instructions
Follow the steps below to run the Accumulo examples:
@@ -132,3 +141,4 @@ This repository can be used to test Accumulo release
candidates. See
[wordcount]: docs/wordcount.md
[ti]: https://github.com/apache/accumulo-examples/workflows/QA/badge.svg
[tl]: https://github.com/apache/accumulo-examples/actions
+[here]: https://accumulo.apache.org/1.10/examples
