UNPKG

9.99 kBMarkdownView Raw
1<!-- TITLE/ -->
2
3<h1>Update Contributors</h1>
4
5<!-- /TITLE -->
6
7
8<!-- BADGES/ -->
9
10<span class="badge-githubworkflow"><a href="https://github.com/bevry/update-contributors/actions?query=workflow%3Abevry" title="View the status of this project's GitHub Workflow: bevry"><img src="https://github.com/bevry/update-contributors/workflows/bevry/badge.svg" alt="Status of the GitHub Workflow: bevry" /></a></span>
11<span class="badge-npmversion"><a href="https://npmjs.org/package/@bevry/update-contributors" title="View this project on NPM"><img src="https://img.shields.io/npm/v/@bevry/update-contributors.svg" alt="NPM version" /></a></span>
12<span class="badge-npmdownloads"><a href="https://npmjs.org/package/@bevry/update-contributors" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/@bevry/update-contributors.svg" alt="NPM downloads" /></a></span>
13<br class="badge-separator" />
14<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
15<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
16<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
17<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
18<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
19<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
20<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
21<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
22<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
23<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
24
25<!-- /BADGES -->
26
27
28<!-- DESCRIPTION/ -->
29
30Update the package.json author, contributors, and maintainers fields with the latest remote data
31
32<!-- /DESCRIPTION -->
33
34
35## Usage
36
37[Complete API Documentation.](http://master.update-contributors.bevry.surge.sh/docs/)
38
39<!-- INSTALL/ -->
40
41<h2>Install</h2>
42
43<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>npm</h3></a>
44<h4>Install Globally</h4>
45<ul>
46<li>Install: <code>npm install --global @bevry/update-contributors</code></li>
47<li>Executable: <code>@bevry/update-contributors</code></li>
48</ul>
49<h4>Install Locally</h4>
50<ul>
51<li>Install: <code>npm install --save @bevry/update-contributors</code></li>
52<li>Executable: <code>npx @bevry/update-contributors</code></li>
53<li>Import: <code>import pkg from ('@bevry/update-contributors')</code></li>
54<li>Require: <code>const pkg = require('@bevry/update-contributors').default</code></li>
55</ul>
56
57<h3><a href="https://editions.bevry.me" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
58
59<p>This package is published with the following editions:</p>
60
61<ul><li><code>@bevry/update-contributors/source/index.ts</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> source code with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li>
62<li><code>@bevry/update-contributors</code> aliases <code>@bevry/update-contributors/edition-es2022/index.js</code></li>
63<li><code>@bevry/update-contributors/edition-es2022/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2022 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 10 || 12 || 14 || 16 || 18 || 20 || 21 with <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a> for modules</li>
64<li><code>@bevry/update-contributors/edition-es2022-esm/index.js</code> is <a href="https://www.typescriptlang.org/" title="TypeScript is a typed superset of JavaScript that compiles to plain JavaScript. ">TypeScript</a> compiled against ES2022 for <a href="https://nodejs.org" title="Node.js is a JavaScript runtime built on Chrome's V8 JavaScript engine">Node.js</a> 12 || 14 || 16 || 18 || 20 || 21 with <a href="https://babeljs.io/docs/learn-es2015/#modules" title="ECMAScript Modules">Import</a> for modules</li></ul>
65
66<!-- /INSTALL -->
67
68
69<!-- HISTORY/ -->
70
71<h2>History</h2>
72
73<a href="https://github.com/bevry/update-contributors/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
74
75<!-- /HISTORY -->
76
77
78<!-- CONTRIBUTE/ -->
79
80<h2>Contribute</h2>
81
82<a href="https://github.com/bevry/update-contributors/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
83
84<!-- /CONTRIBUTE -->
85
86
87<!-- BACKERS/ -->
88
89<h2>Backers</h2>
90
91<h3>Maintainers</h3>
92
93These amazing people are maintaining this project:
94
95<ul><li><a href="https://balupton.com">Benjamin Lupton</a><a href="https://github.com/bevry/update-contributors/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/update-contributors">view contributions</a></li></ul>
96
97<h3>Sponsors</h3>
98
99No sponsors yet! Will you be the first?
100
101<span class="badge-githubsponsors"><a href="https://github.com/sponsors/balupton" title="Donate to this project using GitHub Sponsors"><img src="https://img.shields.io/badge/github-donate-yellow.svg" alt="GitHub Sponsors donate button" /></a></span>
102<span class="badge-thanksdev"><a href="https://thanks.dev/u/gh/balupton" title="Donate to this project using ThanksDev"><img src="https://img.shields.io/badge/thanksdev-donate-yellow.svg" alt="ThanksDev donate button" /></a></span>
103<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
104<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
105<span class="badge-liberapay"><a href="https://liberapay.com/bevry" title="Donate to this project using Liberapay"><img src="https://img.shields.io/badge/liberapay-donate-yellow.svg" alt="Liberapay donate button" /></a></span>
106<span class="badge-buymeacoffee"><a href="https://buymeacoffee.com/balupton" title="Donate to this project using Buy Me A Coffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg" alt="Buy Me A Coffee donate button" /></a></span>
107<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
108<span class="badge-crypto"><a href="https://bevry.me/crypto" title="Donate to this project using Cryptocurrency"><img src="https://img.shields.io/badge/crypto-donate-yellow.svg" alt="crypto donate button" /></a></span>
109<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
110<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
111
112<h3>Contributors</h3>
113
114These amazing people have contributed code to this project:
115
116<ul><li><a href="https://balupton.com">Benjamin Lupton</a><a href="https://github.com/bevry/update-contributors/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/update-contributors">view contributions</a></li></ul>
117
118<a href="https://github.com/bevry/update-contributors/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
119
120<!-- /BACKERS -->
121
122
123<!-- LICENSE/ -->
124
125<h2>License</h2>
126
127Unless stated otherwise all works are:
128
129<ul><li>Copyright &copy; 2020+ <a href="https://balupton.com">Benjamin Lupton</a></li></ul>
130
131and licensed under:
132
133<ul><li><a href="http://spdx.org/licenses/Artistic-2.0.html">Artistic License 2.0</a></li></ul>
134
135<!-- /LICENSE -->