@times-components/article-label/README.md

The article label

# Article Label

An article label is similar to an article flag, in that it is attached to a
particular article as a piece of styled textual data. Article label, however,
indicates which section an article is located in (e.g. "NEWS" or "COMMENT", or
sometimes what content an article has (e.g. "VIDEO" or "YOUTUBE").

## Contributing

Please read [CONTRIBUTING.md](./CONTRIBUTING.md) before contributing to this
package

## Running the code

Please see our main [README.md](../README.md) to get the project running locally

## Development

The code can be formatted and linted in accordance with the agreed standards.

```
yarn fmt
yarn lint
```

## Testing

This package uses [yarn](https://yarnpkg.com) (latest) to run unit tests on each
platform with [jest](https://facebook.github.io/jest/).

```
yarn test:web
```

Visit the official
[storybook](http://components.thetimes.co.uk/?knob-Size%20of%20ad%20placeholder%3A=default&knob-Section=%23333333&selectedKind=Primitives%2FArticle%20Label&selectedStory=Article%20Label&full=0&addons=1&stories=1&panelRight=0&addonPanel=storybooks%2Fstorybook-addon-knobs)
to see our available article label templates.