Merge pull request #8 from dabutvin/metadata

update the metadata

Author: dabutvin

Dockerfile

@@ -1,9 +1,9 @@
 FROM node:10-alpine
 
-LABEL "com.github.actions.name"="Chive Action"
-LABEL "com.github.actions.description"="Generate NOTICE files from package-lock.json"
-LABEL "com.github.actions.icon"="mic"
-LABEL "com.github.actions.color"="purple"
+LABEL "com.github.actions.name"="NOTICE file generator"
+LABEL "com.github.actions.description"="Generate a NOTICE file from your package-lock.json"
+LABEL "com.github.actions.icon"="droplet"
+LABEL "com.github.actions.color"="green"
 
 LABEL "repository"="http://github.com/dabutvin/chive-action"
 LABEL "homepage"="http://github.com/dabutvin/chive-action"

README.md

@@ -1,21 +1,21 @@
-# chive-action
+# NOTICE file generator (chvive-action)
 
 Create a NOTICE attribution file based on your package-lock.json as a github action!
 
-- uses https://www.npmjs.com/package/tiny-attribution-generator and https://clearlydefined.io to generate
+- uses https://www.npmjs.com/package/tiny-attribution-generator (chive) and https://clearlydefined.io to generate
 - optional custom NOTICE_TEMPLATE
 - optional argument for filename to use (--filename)
 - optional argument for including devDependencies (--includeDev) (excluded by default)
 
 add ./github/main.workflow to your repo
 
 ```
-workflow "NOTICE file generate" {
+workflow "NOTICE file generator" {
   on = "push"
-  resolves = ["Chive Action"]
+  resolves = ["NOTICE file generator"]
 }
 
-action "Chive Action" {
+action "NOTICE file generator" {
   uses = "dabutvin/chive-action@master"
   secrets = ["GITHUB_TOKEN"]
 }
@@ -24,7 +24,7 @@ action "Chive Action" {
 with custom file name
 
 ```
-action "Chive Action" {
+action "NOTICE file generator" {
   uses = "dabutvin/chive-action@master"
   secrets = ["GITHUB_TOKEN"]
   args = "--filename=MyNotices.md"
@@ -34,7 +34,7 @@ action "Chive Action" {
 include devDependencies in notices
 
 ```
-action "Chive Action" {
+action "NOTICE file generator" {
   uses = "dabutvin/chive-action@master"
   secrets = ["GITHUB_TOKEN"]
   args = "--includeDev=true"

index.js

@@ -155,8 +155,8 @@ function writeFile(filePath, content, branchName, currentSha) {
   const payload = {
     message: `update ${noticesFileName}`,
     committer: {
-      name: 'dabutvin',
-      email: 'butvinik@outlook.com'
+      name: 'chive-action',
+      email: 'chive.action@gmail.com'
     },
     content,
     branch: branchName
@@ -211,7 +211,7 @@ function getPrBody(coordinates, clearlydefinedSource) {
     if (pkg.license) licenseAvailable++
     return `| ${x} | ${pkg.license} | ${pkg.website} | ${yesno(pkg.copyrights && pkg.copyrights.length)} | ${yesno(pkg.text)} |\n`
   }).sort((a, b) => b.license ? 1 : -1)
-  let result = '## Beep boop. Your notices are updated!\n\n'
+  let result = '## Holy chives! Your notices are updated!\n\n'
   result += `We found license information for  ${licenseAvailable} of ${coordinates.length} total components ${licenseAvailable > 0 ? '🎉' : ''}\n\n`
   result += '<details>\n<summary>\nDetails\n</summary>\n\n'
   result += '| Package | License | Website | Copyrights available | License text available |\n'