Add docs README and comments for runtime actions

Author: elevinskii

INSTALL.md

@@ -0,0 +1,84 @@
+# Installation
+
+Module compatible with both Adobe Commerce SaaS and PaaS.
+
+## Prerequisites
+
+- Node.js 20+
+- Adobe I/O CLI (`npm install -g @adobe/aio-cli`)
+
+## Adobe Console preparation
+
+Go to [Adobe Developer Console](https://developer.adobe.com) and create a new project from the "App Builder" template.
+
+Adding a service "Adobe Commerce as a Cloud Service" is necessary for generating OAuth Server-to-Server credentials.
+
+## Installation
+
+- Clone the repository / download the zip
+- Run `npm install` for installing dependencies
+
+## Environment variables
+
+- Rename default `env.dist` to `.env` for storing environment variables
+
+### Adobe Commerce SaaS ![Compatibility](https://img.shields.io/badge/SaaS%20only-006941)
+
+Go to your project in the Adobe Developer console, and copy-paste the OAuth credentials into `.env` config as they are:
+
+```env
+OAUTH_CLIENT_ID=
+OAUTH_CLIENT_SECRETS=
+OAUTH_TECHNICAL_ACCOUNT_EMAIL=
+OAUTH_TECHNICAL_ACCOUNT_ID=
+OAUTH_SCOPES=
+OAUTH_IMS_ORG_ID=
+```
+
+### Adobe Commerce PaaS ![Compatibility](https://img.shields.io/badge/PaaS%20only-0469e3)
+
+Create an integration in Adobe Commerce on `System > Integrations` (preferably with all permissions) and fill in the
+credentials into `.env` config:
+
+```env
+COMMERCE_CONSUMER_KEY=
+COMMERCE_CONSUMER_SECRET=
+COMMERCE_ACCESS_TOKEN=
+COMMERCE_ACCESS_TOKEN_SECRET=
+```
+
+Once you've finished with credentials, you have to connect your project in the Adobe Developer Console with your App
+Builder application by running the following commands:
+
+```shell
+aio login
+aio console org select
+aio console project select
+aio console workspace select
+aio app use --merge
+```
+
+Last step, you have to register your App Builder namespace in our external backoffice and generate a JWT token:
+
+```shell
+npm run onboarding
+```
+
+## Deploy the app
+
+Congratulations! You're all set for deploying your app.
+
+```shell
+aio app deploy
+```
+
+## Admin UI SDK and enabling in Adobe Commerce
+
+As our app is using Admin UI SDK for extending the admin panel, please be sure to enable it in your Adobe Commerce.
+
+- Go to `System > Configuration > Adobe Services > Admin UI SDK`
+- Enable Admin UI SDK from `General configuration`
+- Click `Configure extensions` and be sure your extension is listed and checked
+- `Refresh registrations` for clearing the cache
+
+Enjoy!

README.md

@@ -0,0 +1,9 @@
+# My Awesome App
+
+Adobe App Builder is a serverless platform for building custom apps and extensions on top of Adobe products
+without managing infrastructure. It provides backend actions, UI apps, and secure API access to quickly
+implement business logic, integrations, and custom workflows.
+
+## Installation
+
+Follow instructions in the [installation guide](INSTALL.md).

actions/commerce/generic/index.js

@@ -1,7 +1,8 @@
 /**
- * Extremely simple example of runtime action, which
- * can be used to call external APIs, receiving events
- * from Adobe Commerce or anything else.
+ * Simple example of runtime action, which can be used to call external APIs,
+ * receiving events from Adobe Commerce or for any other purpose.
+ *
+ * @see https://developer.adobe.com/app-builder/docs/guides/runtime_guides/using-runtime
  */
 
 // eslint-disable-next-line no-unused-vars

package-lock.json

@@ -1,5 +1,5 @@
 {
-  "name": "@ideal-code/create-app-builder",
+  "name": "my-awesome-app",
   "version": "1.0.0",
   "description": "My awesome App Builder app",
   "license": "MIT",

package.json

@@ -1,3 +1,9 @@
+/**
+ * Runtime action for providing registrations for Admin UI SDK.
+ *
+ * @see https://developer.adobe.com/commerce/extensibility/admin-ui-sdk/app-registration
+ */
+
 export const main = () => {
   const extensionId = 'my_awesome_app'