-
Notifications
You must be signed in to change notification settings - Fork 2
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.md #15
base: main
Are you sure you want to change the base?
Update README.md #15
Conversation
Update the readme to match the the vtex-apps template, and add the warning message that this is an unfinished app.
Hi! I'm VTEX IO CI/CD Bot and I'll be helping you to publish your app! 🤖 Please select which version do you want to release:
And then you just need to merge your PR when you are ready! There is no need to create a release commit/tag.
|
Beep boop 🤖 Thank you so much for keeping our documentation up-to-date ❤️ |
@@ -68,3 +78,24 @@ Changes the selected delivery option to be the one which has the given `delivery | |||
```tsx | |||
selectDeliveryOption('PAC') | |||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this info should be divided into different sections: Configuration and Modus Operandi. The Configuration
section should teach users how to set up the app in their VTEX accounts and/or their store themes. In turn, the Modus Operandi
section should contain further info regarding the app behavior i.e. how users should properly use it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The app is still under construction, and most probably it will become private.. It is really urgent to update the readme with the warning for now 🙏
Co-authored-by: Bia <[email protected]>
Update the readme to match the the vtex-apps template, and add the warning message that this is an unfinished app.
What problem is this solving?
How should this be manually tested?
N/A
Checklist/Reminders
README.md
.CHANGELOG.md
.Screenshots or example usage
Type of changes
Notes