Merge pull request #1 from react-admin/initial-review

Initial review

README.md

@@ -1,27 +1,35 @@
-# ReactAdmin Enterprise Edition action
+# React Admin Enterprise Edition action
 
-This action sets up your ReactAdmin Enterprise Edition authentication by creating a `.npmrc` file (or an `.yarnrc.yml` file if you use Yarn v2 or more) and adding your secret token that you can find on your [ReactAdmin Enterprise Edition setup page](https://registry.marmelab.com/setup) to use [private modules](https://marmelab.com/ra-enterprise/#private-modules).
+This action sets up your package manager (`npm` or `yarn`) to use the [React Admin Enterprise Edition](https://marmelab.com/ra-enterprise/) private registry, which is required to download the [private modules](https://marmelab.com/ra-enterprise/#private-modules).
+
+It works by creating a `.npmrc` file (or a `.yarnrc.yml` file if you use Yarn v2 or more) and adding the CI authentication token found on the [React Admin Enterprise Edition setup page](https://registry.marmelab.com/setup).
 
 ## Environnement variable
 
 ### `RA_EE_CI_TOKEN`
 
-You have to provide your ReactAdmin Enterprise Edition secret CI token. Do not paste it directly in your repository but use [Github Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) instead.
+You need to provide your React Admin Enterprise Edition CI authentication token in the `RA_EE_CI_TOKEN` environment variable.
+
+**Notice:** Do not paste it directly in your repository but use [Github Encrypted Secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) instead.
 
 ## Example usage
 
 Create a file: `.github/workflows/ra-ee.yml`
 
-```
-name: ReactAdmin Enterprise Edition CI token Action
+```yml
+name: React Admin Enterprise Edition CI token Action
 on: [push]
 
 jobs:
   ra_enterprise_action_workflow:
     runs-on: ubuntu-latest
-    name: Add ReactAdmin Enterprise Edition CI token
     steps:
-      - uses: react-admin/[email protected]
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Add React Admin Enterprise Edition CI token
+        uses: react-admin/[email protected]
         env:
           RA_EE_CI_TOKEN: ${{secrets.RA_EE_CI_TOKEN}}
+      - name: NPM install
+        run: npm install
 ```

action.yml

@@ -1,12 +1,12 @@
-name: "ReactAdmin Enterprise Edition Action"
+name: "React Admin Enterprise Edition Action"
 description: "Set up your CI to install EE packages"
 author: "Marmelab"
 branding:
   icon: "file-plus"
   color: "blue"
 env:
   RA_EE_CI_TOKEN:
-    description: "ReactAdmin Enterprise Edition secret CI token"
+    description: "React Admin Enterprise Edition CI authentication token"
     required: true
 runs:
   using: "composite"