Skip to content

Move README.md to root of bundled package & add keywords so that they shows on npmjs.org #47

@TomStrepsil

Description

@TomStrepsil

The scout rule on #21:

Add README.mds to NPM packages, so npmjs.com doesn't appear empty

...attempted to provide a useful readme on homepages such as https://www.npmjs.com/package/@asos/web-toggle-point-webpack

However, it missed a pertinent point from npmjs.org docs:

An npm package README.md file must be in the root-level directory of the package.

To rectify, the README.md should be moved out of docs/ in the output package.

Could also consider adding keywords to package.json - they are currently set on the repo root, but that's no good for NPM.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions