From 2f7c845bdc7a8366f983fffa126a21e290a6cfb0 Mon Sep 17 00:00:00 2001
From: Joao Kiyoshi <joao@vizir.com.br>
Date: Tue, 29 Sep 2020 16:39:02 -0300
Subject: [PATCH] Create a README.md file

---
 README.md  | 39 +++++++++++++++++++++++++++++++++++++++
 action.yml |  2 +-
 2 files changed, 40 insertions(+), 1 deletion(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8b8f621
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Github Action: Azure Artifacts .npmrc configuration
+
+Github Action that configures the .npmrc for accessing private packages published on Azure Artifacts.
+
+This action should automate the steps described on this doc: https://docs.microsoft.com/en-us/azure/devops/artifacts/get-started-npm?view=azure-devops&tabs=windows#set-up-your-npmrc-files
+
+## Inputs
+
+### `organization`
+
+**Required** The organization name.  Example: `vizir`.
+
+### `project`
+
+**Required** The project name. This action only works for Feeds created inside a Project.  Example: `vizir`.
+
+### `feeds`
+
+**Required** Comma separated list of feeds to authenticate.  Example: `feed1,feed2`.
+
+### `username`
+
+**Required** The user name that will be set on `~/.npmrc`. Example: `vizir`.
+
+### `token`
+
+**Required** The Personal Access Token (PAT). Example: `abcdef1234567890`.
+
+## Example usage
+
+```
+uses: Vizir/action-azure-artifacts-config-npmrc@1.0
+with:
+  organization: vizir
+  project: vizir
+  feeds: feed1,feed2
+  username: vizir
+  token: ${{ secrets.AZURE_PAT }}
+```
diff --git a/action.yml b/action.yml
index 690cffa..6e35163 100644
--- a/action.yml
+++ b/action.yml
@@ -1,5 +1,5 @@
 name: 'Azure Artifacts .npmrc configuration'
-description: 'action-azure-artifacts-config-npmrc'
+description: 'Github Action that configures the .npmrc for accessing private packages published on Azure Artifacts'
 inputs:
   feeds:
     description: 'Comma separated list of feeds'