Skip to content

Commit

Permalink
Improves getting started section and fixes typos (#317)
Browse files Browse the repository at this point in the history
  • Loading branch information
lmac-1 authored Apr 16, 2023
1 parent 00aefc9 commit 92b7371
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 13 deletions.
2 changes: 1 addition & 1 deletion docs/docs/usage/components/CartProvider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ const products = [
]
```

Additionally, you must verify the cartItems on the server-side before creating the CheckoutSession. For this you can use the [validateCartItems() helper](docs/usage/validate-cart-items).
Additionally, you must verify the cartItems on the server-side before creating the CheckoutSession. For this you can use the [validateCartItems() helper](/docs/usage/serverless/validate-cart-items).

## Client-only Checkout mode

Expand Down
10 changes: 7 additions & 3 deletions docs/docs/welcome/getting-started-client-mode.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,13 @@ https://stripe.com/docs/api/checkout/sessions/object#checkout_session_object-mod

## Using the hook

The hook `useShoppingCart()` provides several utilities and pieces of data for you to use in your application. The examples below won't cover every part of the `useShoppingCart()` API but you can [look at the API](#API) below.
The hook `useShoppingCart()` provides several utilities and pieces of data for you to use in your application. The examples below won't cover every part of the `useShoppingCart()` API but you can explore the documentation to find out more.

### Products Created on Stripe's Dashboard

This is for products you created on the Stripe Dashboard. Stripe provides you with a Price ID String. You don't need a server(less)
To use client only mode, you'll need to add some products on the Stripe Dashboard. Check out [Stripe's documentation](https://stripe.com/docs/products-prices/manage-prices) for more information on how to do this.

Stripe provides you with a Price ID String. You don't need a server(less)
set up to use this library this way unless you want more control over how the payments are handled.

```jsx
Expand All @@ -62,21 +64,23 @@ const productData = [
{
name: 'Bananas',
price_id: 'price_GBJ2Ep8246qeeT',
// price in smallest currency unit (e.g. cent for USD)
price: 400,
image: 'https://www.fillmurray.com/300/300',
currency: 'USD'
},
{
name: 'Tangerines',
price_id: 'price_GBJ2WWfMaGNC2Z',
// price in smallest currency unit (e.g. cent for USD)
price: 100,
image: 'https://www.fillmurray.com/300/300',
currency: 'USD'
}
]

export function App() {
/* Gets the totalPrice and a method for redirecting to stripe */
/* Gets the totalPrice and a method for redirecting to Stripe */
const { totalPrice, redirectToCheckout, cartCount } = useShoppingCart()

return (
Expand Down
12 changes: 7 additions & 5 deletions docs/docs/welcome/getting-started-serverless.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,20 @@ ReactDOM.render(

## Using the hook

The hook `useShoppingCart()` provides several utilities and pieces of data for you to use in your application. The examples below won't cover every part of the `useShoppingCart()` API but you can [look at the API](#API) below.
The hook `useShoppingCart()` provides several utilities and pieces of data for you to use in your application. The examples below won't cover every part of the `useShoppingCart()` API but you can explore the documentation to find out more.

### Serverless implementation

If you're data source isn't coming from Stripe's dashboard, you can still make products and process payments.
If your data source isn't coming from Stripe's dashboard, you can still make products and process payments.

You're product data should look like this:
Your product data should look like this:

```js
const productData = [
{
name: 'Bananas',
id: 'some_unique_id_1',
// price in smallest currency unit (e.g. cent for USD)
price: 400,
image: 'https://www.fillmurray.com/300/300',
currency: 'USD'
Expand All @@ -68,6 +69,7 @@ const productData = [
{
name: 'Tangerines',
id: 'some_unique_id_2',
// price in smallest currency unit (e.g. cent for USD)
price: 100,
image: 'https://www.fillmurray.com/300/300',
currency: 'USD',
Expand All @@ -85,7 +87,7 @@ const productData = [
]
```

_NOTE_: `price_data` and `product_data` are not required for use-shopping-cart to work, but they are required for creating Sessions with Stripe.
_Note_: `price_data` and `product_data` are not required for use-shopping-cart to work, but they are required for creating Sessions with Stripe.

This library manages `price_data` and `product_data` for you, but if you need to pass extra data to your Sessions, you can add them directly to your
product objects.
Expand Down Expand Up @@ -177,7 +179,7 @@ return {
}
```

_NOTE_: `price_data` and `product_data` are not required for use-shopping-cart to work, but they are required for creating Sessions with Stripe.
_Note_: `price_data` and `product_data` are not required for use-shopping-cart to work, but they are required for creating Sessions with Stripe.

This library manages `price_data` and `product_data` for you, but if you need to pass extra data to your Sessions, you can add them directly to your
product objects.
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/welcome/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ There are two ways you can implement this library. Client Only mode and Checkout

## Client Only Mode

This is for anyone who wants to make their products on the Stripe dashboard and doesn't want to manage their
This is for anyone who wants to [configure their products](https://stripe.com/docs/products-prices/manage-prices) on the Stripe Dashboard and doesn't want to manage their
own server. This is a secure, easy way to get up and running.

<Link to="/docs/welcome/getting-started-client-mode">
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/welcome/typescript.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: Getting Started with TypeScript
title: Getting started with TypeScript
id: getting-started-with-typescript
---

This library now works with TypeScript! You can use `use-shopping-cart` just the same as before but now with types. Take for example these two files from our very own `typescript-usage` example workspace.
This library now works with TypeScript! You can use `use-shopping-cart` just the same as before but now with types. Take for example these two files from our very own [`typescript-usage` example workspace](https://github.com/dayhaysoos/use-shopping-cart/tree/master/examples/typescript-usage).

```tsx
import * as React from 'react'
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const Home = () => {
<Feature
title="Developer friendly API"
imageUrl="img/api.svg"
description="Abstract away the complexity of working with Stripe so that you can focus the products your customers love!"
description="Abstract away the complexity of working with Stripe so that you can focus on the products your customers love!"
/>
<Feature
title="Framework agnostic"
Expand Down

0 comments on commit 92b7371

Please sign in to comment.