Skip to content

Commit 917a196

Browse files
Align README: naming conventions and structure with related actions
1 parent b48e2db commit 917a196

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

README.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,26 @@
1-
# MeshStack Auth Action
1+
# meshStack Auth Action
22

3-
This action authenticates to meshStack API.
3+
This GitHub Action authenticates to the meshStack API to enable building block automation workflows.
44

5-
### Overview
5+
## Overview
66

7-
This GitHub Action is designed to authenticate against the Meshfed API. It helps you obtain an access token using client credentials, which can then be used to interact with the Meshfed API securely. This action simplifies the process of obtaining and managing authentication tokens for your workflows.
7+
This GitHub Action is designed to authenticate against the meshStack API. It helps you obtain an access token using client credentials, which can then be used to interact with the meshStack API securely. This action simplifies the process of obtaining and managing authentication tokens for your workflows.
88

9-
### API Documentation
9+
## Related Actions
1010

11-
For more information about the Meshfed API, please refer to the [Meshfed API Documentation](https://docs.meshcloud.io/api/index.html).
11+
This action is part of a suite of GitHub Actions for meshStack building block automation:
1212

13+
- **[actions-meshstack-auth](https://github.com/meshcloud/actions-meshstack-auth)** (this action) - Authenticates to the meshStack API
14+
- **[actions-register-source](https://github.com/meshcloud/actions-register-source)** - Registers building block sources and steps with meshStack
15+
- **[actions-send-status](https://github.com/meshcloud/actions-send-status)** - Sends building block step status updates to meshStack
1316

14-
### Inputs
17+
## Documentation
18+
19+
For more information about meshStack building blocks and GitHub Actions integration, refer to:
20+
- [meshStack GitHub Actions Integration](https://docs.meshcloud.io/integrations/github/github-actions/)
21+
- [meshStack API Documentation](https://docs.meshcloud.io/api/index.html)
22+
23+
## Inputs
1524

1625
- `base_url` (required): meshStack API endpoint.
1726
- `client_id` (required): The client ID for the API.
@@ -21,8 +30,7 @@ For more information about the Meshfed API, please refer to the [Meshfed API Doc
2130

2231
- `token_file`: Path to the file containing the authentication token
2332

24-
25-
### Example Usage
33+
## Example Usage
2634

2735
```yaml
2836
- name: Setup meshStack bbrun

0 commit comments

Comments
 (0)