Skip to content
This repository was archived by the owner on Oct 31, 2024. It is now read-only.

Commit

Permalink
docs: update client package readme
Browse files Browse the repository at this point in the history
  • Loading branch information
patzick committed Aug 12, 2020
1 parent 0a682ba commit e7977fb
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions packages/shopware-6-client/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# API client for Shopware 6

Compatibility with Shopware 6:
[![shopware-ver](https://img.shields.io/badge/version-6.2.3-green)](https://github.com/shopware/platform/releases/tag/v6.2.3)
See compatibility with Shopware 6 in our [docs](https://shopware-pwa-docs.vuestorefront.io/landing/getting-started/prepare-shopware.html#compatibility-table)

## Installing

Expand All @@ -11,19 +10,19 @@ Using yarn:
$ yarn add @shopware-pwa/shopware-6-client
```


## Usage example

A simple example of how to use API client to connect with your Shopware instance.

In main project file setup connection informations.

```js
import {setup} from "@shopware-pwa/shopware-6-client"
import { setup } from "@shopware-pwa/shopware-6-client";

setup({
endpoint: 'https://address-to-my-shopware-instance.com',
accessToken: 'myaccesstoken'
})
endpoint: "https://address-to-my-shopware-instance.com",
accessToken: "myaccesstoken",
});
```

And then anywhere in your project, you can use API Client methods:
Expand All @@ -36,4 +35,4 @@ import { getCategories } from "@shopware-pwa/shopware-6-client"
async mounted() {
this.categories = await getCategories();
}
```
```

0 comments on commit e7977fb

Please sign in to comment.