Skip to content

Commit d7aecea

Browse files
author
Guven Karanfil
committed
update doc
1 parent a840cf5 commit d7aecea

1 file changed

Lines changed: 23 additions & 6 deletions

File tree

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,17 @@ Overall, using testing distribution in mobile DevOps significantly enhances the
7070
efficiency, security, and effectiveness of the software development process,
7171
leading to better products and faster delivery times.
7272

73+
## System Requirements
74+
75+
**Compatible Agents:**
76+
77+
- macOS
78+
- Ubuntu
79+
- Ventura
80+
81+
Note: We currently support **Appcircle Cloud**, with **self-hosted** support
82+
planned in our roadmap.
83+
7384
### Testing Distribution
7485

7586
In order to share your builds with testers, you can create distribution profiles
@@ -105,11 +116,17 @@ Local Action' with the appropriate information.
105116
message: ${{ secrets.MESSAGE }}
106117
```
107118
108-
#### Automatic Profile Management
109-
110-
**createProfileIfNotExists** paramater ensures that a user profile is
111-
automatically created if it does not already exist; if the profile name already
112-
exists, the app will be uploaded to that existing profile instead.
119+
- `personalAPIToken`: The Appcircle Personal API token is utilized to
120+
authenticate and secure access to Appcircle services, ensuring that only
121+
authorized users can perform actions within the platform.
122+
- `profileName`: Specifies the profile that will be used for uploading the app.
123+
- `createProfileIfNotExists`: Ensures that a user profile is automatically
124+
created if it does not already exist; if the profile name already exists, the
125+
app will be uploaded to that existing profile instead.
126+
- `appPath`: Indicates the file path to the application that will be uploaded to
127+
Appcircle Testing Distribution Profile.
128+
- `message`: Your message to testers, ensuring they receive important updates
129+
and information regarding the application.
113130

114131
### Leveraging Environment Variables
115132

@@ -125,7 +142,7 @@ need support or more information, please
125142

126143
### Reference
127144

128-
- For details on generating an Appcircle Personal Access Token, visit
145+
- For details on generating an Appcircle Personal API Token, visit
129146
[Generating/Managing Personal API Tokens](https://docs.appcircle.io/appcircle-api/api-authentication#generatingmanaging-the-personal-api-tokens?utm_source=github&utm_medium=plugin&utm_campaign=testing_distribution)
130147

131148
- To create or learn more about Appcircle testing and distribution profiles,

0 commit comments

Comments
 (0)