Skip to content

Commit

Permalink
chore: add project metadata to package.json (ngworker#148)
Browse files Browse the repository at this point in the history
## PR Checklist

Please check if your PR fulfills the following requirements:

- [x] The commit message follows our guidelines: CONTRIBUTING.md#commit
- [ ] Tests for the changes have been added (for bug fixes / features)
- [x] Docs have been added / updated (for bug fixes / features)

## PR Type

What kind of change does this PR introduce?

<!-- Please check the one that applies to this PR using "x". -->

```
[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[ ] Refactoring (no functional changes, no api changes)
[ ] Build related changes
[ ] CI related changes
[x] Documentation content changes
[ ] Other... Please describe:
```

## What is the current behavior?

The project package.json doesn't contain the necessary metadata that npm
would read. Additionally, the logo is local and therefore not accessible
on npm.


## What is the new behavior?

We have included on the package.json the following metadata:

- description
- homepage
- license
- repository
- keywords
- contributors
- bugs

The lumberjack logo was moved to a CDN.


## Does this PR introduce a breaking change?

```
[ ] Yes
[x] No
```
  • Loading branch information
NachoVazquez committed Jun 12, 2023
1 parent b69d069 commit c1321dd
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
> Chop and cut Angular logs like a professional lumberjack.
<p align="center">
<img width="40%" height="40%" src="./logo.svg">
<img width="40%" height="40%" src="https://pub-2294738bc2c249ff8040505bf960c018.r2.dev/logo.svg">
</p>

[Logo by Felipe Zambrano](http://instagram.com/octopez)
Expand Down
35 changes: 35 additions & 0 deletions packages/ngworker/lumberjack/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,41 @@
{
"name": "@ngworker/lumberjack",
"version": "14.0.0",
"description": "Lumberjack is a versatile Angular logging library, specifically designed to be extended and customized",
"homepage": "https://github.com/ngworker/lumberjack#readme",
"license": "MIT",
"repository": {
"type": "git",
"url": "https://github.com/ngworker/lumberjack.git",
"directory": "packages/ngworker/lumberjack"
},
"keywords": [
"angular",
"angular2",
"lumberjack",
"logging",
"plugin"
],
"contributors": [
{
"name": "Nacho Vazquez",
"email": "[email protected]",
"url": "https://github.com/NachoVazquez"
},
{
"email": "[email protected]",
"name": "Lars Gyrup Brink Nielsen",
"url": "https://github.com/LayZeeDK"
},
{
"email": "[email protected]",
"name": "Santosh Yadav",
"url": "https://github.com/santoshyadavdev"
}
],
"bugs": {
"url": "https://github.com/ngworker/lumberjack/issues?q=is:issue+is:open+"
},
"peerDependencies": {
"@angular/core": "^15.0.1",
"@angular/common": "^15.0.1",
Expand Down

0 comments on commit c1321dd

Please sign in to comment.