diff --git a/README.md b/README.md index f2ab2aaf..d1867166 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,7 @@ data using [Helsinki Design System](https://github.com/City-of-Helsinki/helsinki React Helsinki Headless CMS is a highly customized component library based on [HDS](https://github.com/City-of-Helsinki/helsinki-design-system). It is designed for City of Helsinki web applications using preconfigured WordPress Headless CMS environments. This library provides a set of unified visual components for Pages, Articles, and Article Archives. -[![NPM Version](https://img.shields.io/npm/v/react-helsinki-headless-cms.svg)](https://www.npmjs.com/package/react-helsinki-headless-cms) +[![NPM Version](https://img.shields.io/npm/v/@city-of-helsinki/react-helsinki-headless-cms.svg)](https://www.npmjs.com/package/@city-of-helsinki/react-helsinki-headless-cms) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) It provides: @@ -75,7 +75,7 @@ It provides: ## Installation ```bash -yarn add react-helsinki-headless-cms +yarn add @city-of-helsinki/react-helsinki-headless-cms ``` ## Development @@ -188,15 +188,15 @@ The `yarn dev` command will start `storybook` in port `6006`. When you make chan This can handle data queries for you if you are using a supported library to fetch your data. -By importing data dependent components from `react-helsinki-headless-cms/apollo`, this library will request the data for you. +By importing data dependent components from `@city-of-helsinki/react-helsinki-headless-cms/apollo`, this library will request the data for you. **Note:** An Apollo client linked to a graphql endpoint with a supported schema (headless CMS) must be provided in the `apolloClient` field of the `config` object. **Simplified example** ```tsx -import { Page } from 'react-helsinki-headless-cms/apollo'; -import { Navigation } from 'react-helsinki-headless-cms/apollo'; +import { Page } from '@city-of-helsinki/react-helsinki-headless-cms/apollo'; +import { Navigation } from '@city-of-helsinki/react-helsinki-headless-cms/apollo';