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.

Sign up for GitHub

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

Jump to bottom

Update README.md #15

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update README.md #15

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8da0d97
Update README.md
caetano1 Nov 27, 2020
ae9a7c9
Apply suggestions from code review
caetano1 Dec 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 33 additions & 2 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# Order Shipping
📢 Use this project, [contribute](https://github.com/{OrganizationName}/{AppName}) to it or open issues to help evolve it using [Store Discussion](https://github.com/vtex-apps/store-discussion).
caetano1 marked this conversation as resolved.
Show resolved Hide resolved

# ORDERS SHIPPING
caetano1 marked this conversation as resolved.
Show resolved Hide resolved

⚠️ **This is an ongoing, unsupported, unfinished and undocumented project. We do not guarantee any results after installation.** ⚠️
caetano1 marked this conversation as resolved.
Show resolved Hide resolved

<!-- DOCS-IGNORE:start -->
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<!-- DOCS-IGNORE:end -->

> Centralizes all shipping related requests to the Checkout API.

Any kind of shipping query or manipulation should be made through this component. This ensures that each interaction with the Checkout API happens in succession, avoiding concurrency issues.
caetano1 marked this conversation as resolved.
Show resolved Hide resolved

## Usage
## Configuration

Use the hook `useOrderShipping` to get access to the API methods. Your component must be contained in a `OrderShippingProvider`, which in turn must be contained in a `OrderFormProvider` inside a `OrderQueueProvider`.

Expand Down Expand Up @@ -68,3 +78,24 @@ Changes the selected delivery option to be the one which has the given `delivery
```tsx
selectDeliveryOption('PAC')
```
Copy link

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.

Copy link
Author

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 🙏


## Customization

TBC
caetano1 marked this conversation as resolved.
Show resolved Hide resolved

<!-- DOCS-IGNORE:start -->

## Contributors ✨

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

<!-- DOCS-IGNORE:end -->