Better docu

futuredapp · Oct 19, 2016 · 4bef889 · 4bef889
1 parent 396b7a3
commit 4bef889
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 26 deletions.
diff --git a/bitrise.yml b/bitrise.yml
@@ -70,8 +70,8 @@ workflows:
   share-this-step:
     envs:
       # if you want to share this step into a StepLib
-      - MY_STEPLIB_REPO_FORK_GIT_URL: $MY_STEPLIB_REPO_FORK_GIT_URL
-      - STEP_ID_IN_STEPLIB: deploy-to-bitrise-io
+      - MY_STEPLIB_REPO_FORK_GIT_URL: https://github.com/thefuntasty/bitrise-steplib
+      - STEP_ID_IN_STEPLIB: bitrise-step-android-info
       - STEP_GIT_VERION_TAG_TO_SHARE: $STEP_VERSION
       - STEP_GIT_CLONE_URL: https://github.com/thefuntasty/bitrise-step-android-info.git
     description: |-

diff --git a/step.yml b/step.yml
@@ -2,16 +2,13 @@ title: "Android info"
 summary: |-
   Android APK info provider
 description: |-
-  Generic artifacts deployer, attaches the artifacts to bitrise.io builds.
-
-  You'll see the deployed files on bitrise.io, on the build's page,
-  in the "Apps and Artifacts" section.
+  Provides all possible Android APK information as package name, version name or version code.
 website: https://github.com/thefuntasty/bitrise-step-android-info
 source_code_url: https://github.com/thefuntasty/bitrise-step-android-info
 support_url: https://github.com/thefuntasty/bitrise-step-android-info/issues
-host_os_tags:
-  - "osx-10.10"
-project_type_tags: []
+project_type_tags:
+  - "android"
+  - "apk"
 type_tags:
   - artifact
 is_requires_admin_user: false
@@ -21,48 +18,45 @@ run_if: .IsCI
 inputs:
   - deploy_path: "$BITRISE_DEPLOY_DIR"
     opts:
-      title: "Deploy directory or file path"
+      title: "Deploy directory or APK file path"
       description: |
         Specify the directory or file path which will be deployed.
         If the specified path is a directory then every file
         in the directory will be deployed - but only the
         files in the specified directory, sub-directories
-        won't be uploaded. For uploading the directory's content
-        recursively you should use the *Compress* option
-        which will compress the whole directory, with
-        every sub-directory included.
+        won't be uploaded.
 
         If you specify a file path then only the specified
         file will be deployed.
       is_required: true
 outputs:
   - ANDROID_APP_PACKAGE_NAME:
     opts:
-      title: Android package name
+      title: Android application package name
       description: |-
-        Android package name, ex. com.package.my
+        Android application package name, ex. com.package.my
   - ANDROID_APK_FILE_SIZE:
     opts:
-      title: Android package name
+      title: Android APK file size
       description: |-
-        Android package name, ex. com.package.my
+        Android APK file size, in bytes
   - ANDROID_APP_NAME:
     opts:
-      title: Android package name
+      title: Android application name
       description: |-
-        Android package name, ex. com.package.my
+        Android application name from APK
   - ANDROID_APP_VERSION_NAME:
     opts:
-      title: Android package name
+      title: Android application version name
       description: |-
-        Android package name, ex. com.package.my
+        Android application version name from APK, ex. 1.0.0
   - ANDROID_APP_VERSION_CODE:
     opts:
-      title: Android package name
+      title: Android application version code
       description: |-
-        Android package name, ex. com.package.my
+        Android application version code from APK, ex. 10
   - ANDROID_ICON_PATH:
     opts:
-      title: Android package name
+      title: File path to icon
       description: |-
-        Android package name, ex. com.package.my
+        File path to android application icon