Skip to content
This repository has been archived by the owner on Aug 13, 2023. It is now read-only.

Add Storybook badges to package READMEs #231

Merged
merged 8 commits into from
Dec 21, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/components/psammead-brand/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@

| Version | Description |
| ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 0.1.2 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.1 | [PR#202](https://github.com/BBC-News/psammead/pull/202) Fixes a styling bug caused by an [incorrect constant import](https://github.com/BBC-News/psammead/issues/201). |
| 0.1.0 | [PR#105](https://github.com/BBC-News/psammead/pull/105) Create initial package, pulled in from [simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-brand/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Brand · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-brand.svg)](https://www.npmjs.com/package/@bbc/psammead-brand) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-brand · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=Brand) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-brand.svg)](https://www.npmjs.com/package/@bbc/psammead-brand) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

## Description
The `Brand` component provides the BBC News logo (as SVG), nested inside a styled span, link and div. The link is currently hardcoded to "https://www.bbc.co.uk/news". `Brand` takes a `brandName` as a prop. This prop is passed to a [VisuallyHiddenText](../VisuallyHiddenText) component, nested inside Brand. Note that this does not currently affect the branding itself, which always renders as `BBC NEWS`.
Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-brand/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-brand/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-brand",
"version": "0.1.1",
"version": "0.1.2",
"main": "dist/index.js",
"description": "Provides the BBC News logo (as SVG), nested a hardcoded link to https://www.bbc.co.uk/news",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-caption/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@

| Version | Description |
|---------|-------------|
| 0.1.1 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.0 | [PR#186](https://github.com/BBC-News/psammead/pull/186) Create initial package, pulled in from [Simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-caption/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-caption · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-caption.svg)](https://www.npmjs.com/package/@bbc/psammead-caption) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-caption · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=Caption) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-caption.svg)](https://www.npmjs.com/package/@bbc/psammead-caption) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

## Description
The `psammead-caption` component is a styled `figcaption` element.
Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-caption/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-caption/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-caption",
"version": "0.1.0",
"version": "0.1.1",
"main": "dist/index.js",
"description": "React styled components for a Caption",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-copyright/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@

| Version | Description |
|---------|-------------|
| 0.2.1 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.2.0 | [PR#187](https://github.com/BBC-News/psammead/pull/187) Change PRs Welcome link, creating src directory. |
| 0.1.0 | [PR#129](https://github.com/BBC-News/psammead/pull/129) Create initial package, pulled in from [simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-copyright/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-copyright · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-copyright.svg)](https://www.npmjs.com/package/@bbc/psammead-copyright) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-copyright · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=Copyright) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-copyright.svg)](https://www.npmjs.com/package/@bbc/psammead-copyright) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

### Description
Displays the source attribution of an image in block capitals in the bottom-right of the parent element.
Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-copyright/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-copyright/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-copyright",
"version": "0.2.0",
"version": "0.2.1",
"main": "dist/index.js",
"description": "React styled component for overlaid copyright or source attribution.",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-headings/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

| Version | Description |
|---------|-------------|
| 0.1.4 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.3 | [PR#173](https://github.com/BBC-News/psammead/pull/173) Update PRs welcome link |
| 0.1.2 | [PR#119](https://github.com/BBC-News/psammead/pull/119) Publish as babel 7 |
| 0.1.1 | [PR#100](https://github.com/BBC-News/psammead/pull/100) Fix links to repo and homepage |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-headings/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-headings · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-headings.svg)](https://www.npmjs.com/package/@bbc/psammead-headings) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-headings · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=Headline) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-headings.svg)](https://www.npmjs.com/package/@bbc/psammead-headings) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

## Description

Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-headings/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-headings/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-headings",
"version": "0.1.3",
"version": "0.1.4",
"main": "dist/index.js",
"description": "React styled components for a Headline and SubHeading",
"repository": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@

| Version | Description |
|---------|-------------|
| 0.1.2 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.1 | [PR#228](https://github.com/BBC-News/psammead/pull/228) Ensure package-lock is https. |
| 0.1.0 | [PR#213](https://github.com/BBC-News/psammead/pull/213) Create initial package, pulled in from [simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-image-placeholder/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-image-placeholder · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-image-placeholder.svg)](https://www.npmjs.com/package/@bbc/psammead-image-placeholder) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-image-placeholder · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=ImagePlaceholder) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-image-placeholder.svg)](https://www.npmjs.com/package/@bbc/psammead-image-placeholder) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

## Description

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-image-placeholder",
"version": "0.1.1",
"version": "0.1.2",
"main": "dist/index.js",
"description": "Provides a 'BBC' image placeholder",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-inline-link/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@

| Version | Description |
|---------|-------------|
| 0.1.1 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.0 | [PR#106](https://github.com/BBC-News/psammead/pull/106) Create initial package with Inline Link component pulled in from [Simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-inline-link/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-inline-link · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-inline-link.svg)](https://www.npmjs.com/package/@bbc/psammead-inline-link) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
# psammead-inline-link · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=InlineLink) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-inline-link.svg)](https://www.npmjs.com/package/@bbc/psammead-inline-link) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)

## Description

Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-inline-link/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-inline-link/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-inline-link",
"version": "0.1.0",
"version": "0.1.1",
"description": "React styled component for an Inline Link",
"main": "dist/index.js",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-paragraph/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

| Version | Description |
|---------|-------------|
| 0.1.5 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.4 | [PR#173](https://github.com/BBC-News/psammead/pull/173) Update PRs welcome link |
| 0.1.3 | [PR#164](https://github.com/BBC-News/psammead/pull/164) Bump to ensure `dist` includes Typography fix from 0.1.2. |
| 0.1.2 | [PR#134](https://github.com/BBC-News/psammead/pull/134) Import correct Typography variable `GEL_BODY_COPY` |
Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-paragraph/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-paragraph · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-paragraph.svg)](https://www.npmjs.com/package/@bbc/psammead-paragraph) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-paragraph · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=Paragraph) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-paragraph.svg)](https://www.npmjs.com/package/@bbc/psammead-paragraph) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

## Description

Expand Down
2 changes: 1 addition & 1 deletion packages/components/psammead-paragraph/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-paragraph/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-paragraph",
"version": "0.1.4",
"version": "0.1.5",
"description": "React styled component for a Paragraph",
"main": "dist/index.js",
"repository": {
Expand Down
1 change: 1 addition & 0 deletions packages/components/psammead-sitewide-links/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@

| Version | Description |
|---------|-------------|
| 0.1.1 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.0 | [PR#154](https://github.com/BBC-News/psammead/pull/154) Create initial package with SitewideLinks component pulled in from [Simorgh](https://github.com/BBC-News/simorgh). |
2 changes: 1 addition & 1 deletion packages/components/psammead-sitewide-links/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-sitewide-links · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-sitewide-links.svg)](https://www.npmjs.com/package/@bbc/psammead-sitewide-links) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)
# psammead-sitewide-links · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=SitewideLinks) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-sitewide-links.svg)](https://www.npmjs.com/package/@bbc/psammead-sitewide-links) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://reactjs.org/docs/how-to-contribute.html#your-first-pull-request)

## Description

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion packages/components/psammead-sitewide-links/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-sitewide-links",
"version": "0.1.0",
"version": "0.1.1",
"description": "React styled component for a sitewide-links",
"main": "dist/index.js",
"repository": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

| Version | Description |
| --------------------- |
| 0.1.5 | [PR#231](https://github.com/BBC-News/psammead/pull/231) Add link to Storybook to README |
| 0.1.4 | [PR#173](https://github.com/BBC-News/psammead/pull/173) Update PRs welcome link |
| 0.1.3 | [PR#172](https://github.com/BBC-News/psammead/pull/172) Update README.md to include common sections. |
| 0.1.2 | [PR#125](https://github.com/BBC-News/psammead/pull/125) Bump to ensure built with Babel 7 |
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# psammead-visually-hidden-text · [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-visually-hidden-text.svg)](https://www.npmjs.com/package/@bbc/psammead-visually-hidden-text) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
# psammead-visually-hidden-text · [![Storybook](https://github.com/storybooks/press/blob/master/badges/storybook.svg)](https://bbc-news.github.io/psammead/?selectedKind=VisuallyHiddenText) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/BBC-News/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-visually-hidden-text.svg)](https://www.npmjs.com/package/@bbc/psammead-visually-hidden-text) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)

### Description

Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@bbc/psammead-visually-hidden-text",
"version": "0.1.4",
"version": "0.1.5",
"main": "dist/index.js",
"description": "React styled component for visually hidden text (for screen readers)",
"repository": {
Expand Down