Merge branch 'latest' into replace-storybook-addon

packages/components/psammead-story-promo-list/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Psammead Media Indicator Changelog
+
+<!-- prettier-ignore -->
+| Version | Description |
+| ------- | ----------- |
+| 0.1.0-alpha.1 | [PR#486](https://github.com/BBC-News/psammead/pull/486) Create initial package. |

packages/components/psammead-story-promo-list/README.md

@@ -0,0 +1,82 @@
+# ⛔️ This is an alpha component  ⛔️
+This component is currently tagged as alpha and is not suitable for production use. Following the passing of an accessibility review this component will be marked as ready for production and the alpha tag removed.
+
+# psammead-story-promo-list - [![Known Vulnerabilities](https://snyk.io/test/github/bbc/psammead/badge.svg?targetFile=packages%2Fcomponents%2Fpsammead-story-promo-list%2Fpackage.json)](https://snyk.io/test/github/bbc/psammead?targetFile=packages%2Fcomponents%2Fpsammead-story-promo-list%2Fpackage.json) [![Storybook](https://raw.githubusercontent.com/storybooks/story-promo-list/master/badge/badge-storybook.svg?sanitize=true)](https://bbc.github.io/psammead/?path=/story/story-promo-list--default) [![GitHub license](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/bbc/psammead/blob/latest/LICENSE) [![npm version](https://img.shields.io/npm/v/@bbc/psammead-story-promo-list.svg)](https://www.npmjs.com/package/@bbc/psammead-story-promo-list) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md)
+
+## Description
+
+The `@bbc/psammead-story-promo-list` package is a set of two components, `StoryPromoUl` and `StoryPromoLi`. They use `ul` and `li` HTML elements respectively.
+
+## Installation
+
+`npm install @bbc/psammead-story-promo-list`
+
+## Props
+
+| Argument | Type | Required | Default | Example        |
+| -------- | ---- | -------- | ------- | -------------- |
+| children | node | Yes      | N/A     | `<StoryPromoLi><StoryPromo image={Image} info={Info} /></StoryPromoLi>` |
+
+## Usage
+
+Commonly used alongside [`psammead-story-promo`](https://github.com/BBC-News/psammead/tree/latest/packages/components/psammead-story-promo).
+
+```jsx
+import React, { Fragment } from 'react';
+import StoryPromo, { Headline, Summary } from '@bbc/psammead-story-promo';
+import { StoryPromoLi, StoryPromoUl } from '@bbc/psammead-story-promo-list';
+import { latin } from '@bbc/gel-foundations/scripts';
+
+const Image = (
+  <img src="https://foobar.com/image.jpg" />
+);
+
+const Info = (
+  <Fragment>
+    <Headline script={latin}>The headline of the promo</Headline>
+    <Summary script={latin}>The summary of the promo</Summary>
+    <time>12 March 2019</time>
+  </Fragment>
+);
+
+<StoryPromo
+  image={Image}
+  info={Info}
+/>
+
+<StoryPromoUl>
+  <StoryPromoLi>
+    <StoryPromo image={Image} info={Info} />;
+  </StoryPromoLi>
+  <StoryPromoLi>
+    <StoryPromo image={Image} info={Info} />;
+  </StoryPromoLi>
+</StoryPromoUl>
+
+```
+
+### When to use this component
+
+This component is designed to be used with story promos on 'index' pages.
+
+<!-- ### When not to use this component -->
+
+### Accessibility notes
+
+We have added the role `list` and `listitem` to the corresponding list items due to a VoiceOver bug to reinstate the list semantics.
+
+We haven't yet thoroughly looked at cross device browser AT testing yet, this is in-progress. We will update with a11y notes when carrying out a proper release.
+
+<!-- ## Roadmap -->
+
+## Contributing
+
+Psammead is completely open source. We are grateful for any contributions, whether they be new components, bug fixes or general improvements. Please see our primary contributing guide which can be found at [the root of the Psammead respository](https://github.com/bbc/psammead/blob/latest/CONTRIBUTING.md).
+
+### [Code of Conduct](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md)
+
+We welcome feedback and help on this work. By participating in this project, you agree to abide by the [code of conduct](https://github.com/bbc/psammead/blob/latest/CODE_OF_CONDUCT.md). Please take a moment to read it.
+
+### License
+
+Psammead is [Apache 2.0 licensed](https://github.com/bbc/psammead/blob/latest/LICENSE).