@bbc/psammead-assets - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

@@ -5,4 +5,5 @@ # Psammead Assets Changelog
 |---------|-------------|
+| 0.1.3   | [PR#212](https://github.com/BBC-News/psammead/pull/212) Update package description and README. |
 | 0.1.2   | [PR#173](https://github.com/BBC-News/psammead/pull/173) Update PRs welcome link |
 | 0.1.1   | [PR#74](https://github.com/BBC-News/psammead/pull/74) Move file contents into a src directory and babel transpile prepublish. |
 | 0.1.0   | [PR#49](https://github.com/BBC-News/psammead/pull/49) Create initial package, pulled in from [simorgh](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md). |

package.json

 {
   "name": "@bbc/psammead-assets",
-  "version": "0.1.2",
-  "description": "A collection of BBC assets including svgs",
+  "version": "0.1.3",
+  "description": "A collection of common assets that are likely to be required by many Psammead components or users, such as SVGs or small scripts.",
   "repository": {
@@ -6,0 +6,0 @@ "type": "git",

README.md

 # psammead-assets · [![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-assets.svg)](https://www.npmjs.com/package/@bbc/psammead-assets) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/BBC-News/psammead/blob/latest/CONTRIBUTING.md)
 
-This package is a collection of variable constants which can be imported into your application.
+This package provides a collection of common assets that are likely to be required by many Psammead components or users, such as SVGs or small scripts.
 
+## Exports
+
+`/amp-boilerplate` - A helper, allowing projects using Psammead to easily pull in a versioned copy of [AMP's required boilerplate scripts](https://github.com/ampproject/amphtml/blob/master/spec/amp-boilerplate.md).
+`/svgs` - SVG icons commonly required by projects using Psammead.
+
 ## Installation
@@ -6,0 +11,0 @@

New alerts

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11067

increased by5.2%

Number of lines in readme file

35

increased by16.67%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes