From 5fb2f047e26679d7846a8370de1642ff160b9025 Mon Sep 17 00:00:00 2001
From: Sviatoslav Sydorenko <wk@sydorenko.org.ua>
Date: Mon, 25 Jul 2022 23:13:35 +0200
Subject: [PATCH] Drop `__token__` from README code usage snippets

This patch reduces the emphasis on the `__token__` value of the `user`
input since it's default anyway. It also adds a separate paragraph
showing how to specify a custom username if the need be.

Ref: https://github.com/pypa/packaging.python.org/issues/1108
---
 README.md | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

diff --git a/README.md b/README.md
index a799e98..3c05b43 100644
--- a/README.md
+++ b/README.md
@@ -25,7 +25,6 @@ To use the action add the following step to your workflow file (e.g.
 - name: Publish a Python distribution to PyPI
   uses: pypa/gh-action-pypi-publish@release/v1
   with:
-    user: __token__
     password: ${{ secrets.PYPI_API_TOKEN }}
 ```
 
@@ -50,7 +49,6 @@ So the full step would look like:
   if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
   uses: pypa/gh-action-pypi-publish@release/v1
   with:
-    user: __token__
     password: ${{ secrets.PYPI_API_TOKEN }}
 ```
 
@@ -112,7 +110,6 @@ The action invocation in this case would look like:
 - name: Publish package to TestPyPI
   uses: pypa/gh-action-pypi-publish@release/v1
   with:
-    user: __token__
     password: ${{ secrets.TEST_PYPI_API_TOKEN }}
     repository_url: https://test.pypi.org/legacy/
 ```
@@ -127,7 +124,6 @@ would now look like:
 - name: Publish package to PyPI
   uses: pypa/gh-action-pypi-publish@release/v1
   with:
-    user: __token__
     password: ${{ secrets.PYPI_API_TOKEN }}
     packages_dir: custom-dir/
 ```
@@ -181,6 +177,18 @@ It will show SHA256, MD5, BLAKE2-256 values of files to be uploaded.
     print_hash: true
 ```
 
+### Specifying a different username
+
+The default username value is `__token__`. If you publish to a custom
+registry that does not provide API tokens, like `devpi`, you may need to
+specify a custom username and password pair. This is how it's done.
+
+```yml
+  with:
+    user: guido
+    password: ${{ secrets.DEVPI_PASSWORD }}
+```
+
 ## License
 
 The Dockerfile and associated scripts and documentation in this project