Skip to content

Commit

Permalink
chore: move .md files to published package (#232)
Browse files Browse the repository at this point in the history
This moves `README.md`, `LICENSE.md` and `CHANGELOG.md` from the
repository root into the `./addon` directory.

In doing so, the three files will be picked up by `npm pack` and
`npm publish` respectively, so that the npmjs.com listing shows
the proper `README.md` instead of an error message, and so that these
files are also available in the users `node_modules`.

It also adds symlinks from the old location to the new location, so that
GitHub still renders the repository overview correctly. It's important,
that the files are physically moved instead of just symlinked into the
package, as `npm pack` doesn't follow symlinks.

`CONTRIBUTING.md` is intentionally not moved, as it's only relevant in
the context of the repository.
  • Loading branch information
SergeAstapov committed Apr 11, 2022
1 parent 7ec635a commit 16bd8f6
Show file tree
Hide file tree
Showing 8 changed files with 275 additions and 242 deletions.
116 changes: 0 additions & 116 deletions CHANGELOG.md

This file was deleted.

1 change: 1 addition & 0 deletions CHANGELOG.md
9 changes: 0 additions & 9 deletions LICENSE.md

This file was deleted.

1 change: 1 addition & 0 deletions LICENSE.md
113 changes: 0 additions & 113 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md

0 comments on commit 16bd8f6

Please sign in to comment.