(tooling-releases-client) branch main updated: Added Quick Start to README

[wa...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

wave pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-releases-client.git


The following commit(s) were added to refs/heads/main by this push:
     new 9149ac7  Added Quick Start to README
9149ac7 is described below

commit 9149ac705e6d52cc5237deb71a07bfa23d6c7b16
Author: Dave Fisher <da...@comcast.net>
AuthorDate: Fri Aug 1 11:57:44 2025 -0700

    Added Quick Start to README
---
 README.md | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/README.md b/README.md
index 54019b0..40c634e 100644
--- a/README.md
+++ b/README.md
@@ -7,3 +7,23 @@ This project is maintained by ASF Tooling. As of July 2025, we have only just st
 Please feedback to the ASF Tooling mailing list, or the `#apache-trusted-releases` Slack. We welcome contributions already, and you may file issues or create pull requests. To assist us in reviewing your code, please adhere to our style guidelines as noted in the codebase. Thank you.
 
 The ATR API is not stable, so please do not rely on its schema. The client CLI is also not stable, so please do not use it in unattended scripts.
+
+## Quick Start
+
+1. Installation of **atr** client from within a target directory.
+
+   ```
+   python3 -m venv venv
+   source venv/bin/activate
+   pip3 install -U pip setuptools wheel
+   pip3 install git+https://github.com/apache/tooling-releases-client atr
+   atr --version
+   ```
+
+2. Configuration
+
+   ```
+   atr set asf.uid <your asf id>
+   atr set tokens.pat "<pat from ATR site>"
+   atr config file
+   ```


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@tooling.apache.org
For additional commands, e-mail: commits-help@tooling.apache.org