diff --git a/README.md b/README.md index cee3aaed..da2b6637 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Generic Bitrise deployer Step. ## How to use this Step -Can be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise), +It can be run directly with the [bitrise CLI](https://github.com/bitrise-io/bitrise), just `git clone` this repository, `cd` into it's folder in your Terminal/Command Line and call `bitrise run test`. @@ -15,7 +15,7 @@ Step by step: 1. Open up your Terminal / Command Line 2. `git clone` the repository -3. `cd` into the directory of the step (the one you just `git clone`d) +3. `cd` into the directory of the step (the one which was just `git clone`d) 5. Create a `.bitrise.secrets.yml` file in the same directory of `bitrise.yml` - the `.bitrise.secrets.yml` is a git ignored file, you can store your secrets in 6. Check the `bitrise.yml` file for any secret you should set in `.bitrise.secrets.yml` * Best practice is to mark these options with something like `# define these in your .bitrise.secrets.yml`, in the `app:envs` section. @@ -41,7 +41,7 @@ envs: __For Step development guidelines & best practices__ check this documentation: [https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md](https://github.com/bitrise-io/bitrise/blob/master/_docs/step-development-guideline.md). -**NOTE:** +**NOTE** If you want to use your step in your project's `bitrise.yml`: @@ -63,16 +63,16 @@ in the [bitrise CLI repository](https://github.com/bitrise-io/bitrise/blob/maste 1. Fork this repository 2. `git clone` it -3. Create a branch you'll work on +3. Create a branch that you'll work on 4. To use/test the step just follow the **How to use this Step** section -5. Do the changes you want to +5. Do the changes you want to do 6. Run/test the step before sending your contribution * You can also test the step in your `bitrise` project, either on your Mac or on [bitrise.io](https://www.bitrise.io) * You just have to replace the step ID in your project's `bitrise.yml` with either a relative path, or with a git URL format * (relative) path format: instead of `- original-step-id:` use `- path::./relative/path/of/script/on/your/Mac:` * direct git URL format: instead of `- original-step-id:` use `- git::https://github.com/user/step.git@branch:` * You can find more example of alternative step referencing at: https://github.com/bitrise-io/bitrise/blob/master/_examples/tutorials/steps-and-workflows/bitrise.yml -7. Once you're done just commit your changes & create a Pull Request +7. Once you're done, commit your changes & create a Pull Request ## Share your own Step