From d79b48b93f9042fc45aae8789662801fd0ead2b3 Mon Sep 17 00:00:00 2001 From: Jamie Howard Date: Mon, 16 Dec 2024 15:40:21 +0000 Subject: [PATCH 1/2] chore: readme linting --- README.md | 30 +++++++++++++++++++++++------- 1 file changed, 23 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 2924009..1c532d1 100644 --- a/README.md +++ b/README.md @@ -45,36 +45,44 @@ 5. [Examples](#-examples) ## πŸ›  Getting started + ### Pre-Requisites + Before you begin, ensure you have the following: + - A Strapi backend up and running: [quick start guide](https://docs.strapi.io/dev-docs/quick-start). - The API URL of your Strapi instance: for example, `http://localhost:1337/api`. - A recent version of [Node.js](https://nodejs.org/en/download/package-manager) installed. ### Installation + Install the SDK as a dependency in your project: **NPM** + ```bash npm install @strapi/sdk-js ``` **Yarn** + ```bash yarn add @strapi/sdk-js ``` **pnpm** + ```bash pnpm add @strapi/sdk-js ``` ## βš™οΈ Creating and configuring the SDK Instance + ### Basic configuration To interact with your Strapi backend, initialize the SDK with your Strapi API base URL: -``` typescript +```typescript import { createStrapiSDK } from '@strapi/sdk-js'; const sdk = createStrapiSDK({ baseURL: 'http://localhost:1337/api' }); @@ -82,7 +90,7 @@ const sdk = createStrapiSDK({ baseURL: 'http://localhost:1337/api' }); Alternatively, use a `