Skip to content

Commit d8ed51c

Browse files
authored
Update README.md for Checkout Kit Rename (#228)
1 parent 3689445 commit d8ed51c

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
1-
# Shopify Checkout Sheet Kit - React Native
1+
# Shopify Checkout Kit - React Native
22

33
[![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg?style=flat)](https://github.com/Shopify/checkout-sheet-kit-react-native/blob/main/LICENSE)
44
[![GitHub Release](https://img.shields.io/github/release/shopify/checkout-sheet-kit-react-native.svg?style=flat)]()
55

6-
![image](https://github.com/Shopify/checkout-sheet-kit-react-native/assets/2034704/73246cc6-bd39-4130-a7df-69b06907b897)
6+
<img width="3200" height="800" alt="gradients" src="https://github.com/user-attachments/assets/156492b7-5a64-43d2-b574-2e8f29ed8780" />
77

8-
**Shopify Checkout Sheet Kit** is a Native Module that enables React Native apps
8+
**Shopify Checkout Kit** is a Native Module that enables React Native apps
99
to provide the world’s highest converting, customizable, one-page checkout
1010
within the app. The presented experience is a fully-featured checkout that
1111
preserves all of the store customizations: Checkout UI extensions, Functions,
1212
branding, and more. It also provides platform idiomatic defaults such as support
1313
for light and dark mode, and convenient developer APIs to embed, customize, and
1414
follow the lifecycle of the checkout experience.
1515

16+
Note: We're in the process of renaming "Checkout Sheet Kit" to "Checkout Kit." The dev docs and README already use the new name, while the package itself will be updated in an upcoming version.
17+
1618
Check out our blog to
17-
[learn how and why we built the Shopify Checkout Sheet Kit](https://www.shopify.com/partners/blog/mobile-checkout-sdks-for-ios-and-android).
19+
[learn how and why we built the Shopify Checkout Kit](https://www.shopify.com/partners/blog/mobile-checkout-sdks-for-ios-and-android).
1820

1921
The React Native SDK is part of
2022
[Shopify's Mobile Kit](https://shopify.dev/docs/custom-storefronts/mobile-kit)
@@ -70,14 +72,14 @@ experiences.
7072

7173
## Getting Started
7274

73-
Shopify Checkout Sheet Kit is an open-source NPM package.
75+
Shopify Checkout Kit is an open-source NPM package.
7476

7577
Use the following steps to get started with adding it to your React Native
7678
application:
7779

7880
### 1. Installation
7981

80-
Install the Shopify Checkout Sheet Kit package dependency:
82+
Install the Shopify Checkout Kit package dependency:
8183

8284
```sh
8385
yarn add @shopify/checkout-sheet-kit
@@ -767,7 +769,7 @@ Android differs to iOS in that permission requests must be handled in two places
767769
<uses-permission android:name="android.permission.ACCESS_COARSE_LOCATION" />
768770
```
769771

770-
The Checkout Sheet Kit native module will emit a `geolocationRequest` event when the webview requests geolocation
772+
The Checkout Kit native module will emit a `geolocationRequest` event when the webview requests geolocation
771773
information. By default, the kit will listen for this event and request access to both coarse and fine access when
772774
invoked.
773775

@@ -840,4 +842,4 @@ See the [contributing documentation](CONTRIBUTING.md) for details on how to get
840842

841843
## License
842844

843-
Shopify's Checkout Sheet Kit is provided under an [MIT License](LICENSE).
845+
Shopify's Checkout Kit is provided under an [MIT License](LICENSE).

0 commit comments

Comments
 (0)