Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README and step descriptions to be more informative #14

Merged
merged 2 commits into from Sep 18, 2023

Conversation

dageforce
Copy link
Contributor

@dageforce dageforce commented Sep 18, 2023

Checklist

  • I've read and followed the Contribution Guidelines
  • step.yml and README.md is updated with the changes (if needed)

Version

Requires a PATCH version update

Context

Updates README.md and step documentation to fix minor issues, be more informative and match Appetize.io's current documentation links.

Changes

  • Updated README.md to show additional info and match Appetize's other supporting templates.
  • Updates step to fix some minor issues (e.g. numbering being incorrect) and update links to new documentation.

Investigation details

N/A

Decisions

  • Intentionally added details in README with regards to host and API (from this PR) as we would like to see this included to support our Private cloud customers who have a custom domain name.

lpusok
lpusok previously approved these changes Sep 18, 2023
Copy link
Contributor

@lpusok lpusok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note: there is a way to autogenerate the readme:

  generate_readme:
    steps:
    - git::https://github.com/bitrise-steplib/steps-readme-generator.git: {}

@lpusok lpusok merged commit b43f7d9 into bitrise-steplib:master Sep 18, 2023
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants