![\"Travis](\"https://img.shields.io/travis/com/bevry/projectz/master.svg\")
\n![\"NPM](\"https://img.shields.io/npm/v/projectz.svg\")
\n![\"NPM](\"https://img.shields.io/npm/dm/projectz.svg\")
\n![\"Dependency](\"https://img.shields.io/david/bevry/projectz.svg\")
\n![\"Dev](\"https://img.shields.io/david/dev/bevry/projectz.svg\")
\n![\"Patreon](\"https://img.shields.io/badge/patreon-donate-yellow.svg\"){kind=icon}
\n![\"Flattr](\"https://img.shields.io/badge/flattr-donate-yellow.svg\"){kind=icon}
\n![\"Liberapay](\"https://img.shields.io/badge/liberapay-donate-yellow.svg\"){kind=icon}
\n![\"Buy](\"https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg\"){kind=icon}
\n![\"Open](\"https://img.shields.io/badge/open%20collective-donate-yellow.svg\"){kind=icon}
\n![\"crypto](\"https://img.shields.io/badge/crypto-donate-yellow.svg\"){kind=icon}
\n![\"PayPal](\"https://img.shields.io/badge/paypal-donate-yellow.svg\"){kind=icon}
\n![\"Wishlist](\"https://img.shields.io/badge/wishlist-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n![\"GitHub](\"https://img.shields.io/badge/github-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzrequire('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is esnext source code with require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [300 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [200 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following Editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nUsed by over [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 projects](https://libraries.io/npm/projectz/dependents) thus far!\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following Editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following Editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following Editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesEnvironments older than Node.js v8 may need Babel's Polyfill or something similar.
\n\n\n\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty LtdHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n\n\nnpm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz aliases projectz/source/index.jsprojectz/source/index.js is ESNext source code for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-node-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2020/index.jsprojectz/edition-es2020/index.js is TypeScript compiled against ES2020 for Node.js 14 with Require for modulesprojectz/edition-es2020-esm/index.js is TypeScript compiled against ES2020 for Node.js 14 with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2020/index.jsprojectz/edition-es2020/index.js is TypeScript compiled against ES2020 for Node.js 14 with Require for modulesprojectz/edition-es2020-esm/index.js is TypeScript compiled against ES2020 for Node.js 14 with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON, or `projectz.cson` for [CSON](https://github.com/bevry/cson)) to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n![\"Status](\"https://github.com/bevry/projectz/workflows/bevry/badge.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2019/index.jsprojectz/edition-es2019/index.js is TypeScript compiled against ES2019 for Node.js with Require for modulesprojectz/edition-es2019-esm/index.js is TypeScript compiled against ES2019 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2021/index.jsprojectz/edition-es2021/index.js is TypeScript compiled against ES2021 for Node.js with Require for modulesprojectz/edition-es2021-esm/index.js is TypeScript compiled against ES2021 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n![\"ThanksDev](\"https://img.shields.io/badge/thanksdev-donate-yellow.svg\"){kind=icon}
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2022/index.jsprojectz/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js with Require for modulesprojectz/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2022/index.jsprojectz/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js with Require for modulesprojectz/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2022/index.jsprojectz/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js with Require for modulesprojectz/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n![\"Discord](\"https://img.shields.io/discord/1147436445783560193?logo=discord&label=discord\")
\n![\"Twitch](\"https://img.shields.io/twitch/status/balupton?logo=twitch\")
\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2022/index.jsprojectz/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js with Require for modulesprojectz/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js with Import for modulesprojectz/edition-types/index.d.ts is TypeScript compiled Types with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your projects data files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your data files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz compile\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz compile\",\n \"posttest\": \"npm run compile\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Data Files\n\nProjectz helps you maintain the following data files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple meta data files, you may find defining a projectz meta file (`projectz.json` for JSON to be useful. The projectz meta file can serve as a central location for the configuration of all the other files. However, if you only require one meta data file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd npm install --global projectzprojectznpm install --save projectznpx projectzimport * as pkg from ('projectz')const pkg = require('projectz')This package is published with the following editions:
\n\nprojectz/source/index.ts is TypeScript source code with Import for modulesprojectz aliases projectz/edition-es2022/index.jsprojectz/edition-es2022/index.js is TypeScript compiled against ES2022 for Node.js with Require for modulesprojectz/edition-es2022-esm/index.js is TypeScript compiled against ES2022 for Node.js with Import for modulesprojectz/edition-types/index.d.ts is TypeScript compiled Types with Import for modulesHISTORY.md file.\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nCONTRIBUTING.md file.\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your project's package files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your package files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [deno](https://deno.land)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz\",\n \"posttest\": \"projectz\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Package Files\n\nProjectz helps you maintain the following package files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple package files, you may find defining a `projectz.json` package file will help, as it can serve as a central location for the configuration of all the other files. However, if you only require one package file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd \n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io/) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io/)\n- [entroniq](https://gitlab.com/entroniq)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://bevry.me)\n- [Mohammed Shah](https://github.com/smashah)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"a4c359beaaaea1bb5e91f1e9f4693fa7c0a685f4","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-R6oylLQ6/KC8BkcJPVBrbG1NZesQWEMo0XGCXIgTzrYTc/3rJIjUwKKSm4/JVn1iIt/ZvfMWG4hXfI27q+J5OA==","shasum":"cb1eee89c44b3e4702803ff810d90fc391666ce4","tarball":"https://registry.npmjs.org/projectz/-/projectz-4.0.0-next.1703642487.a4c359beaaaea1bb5e91f1e9f4693fa7c0a685f4.tgz","fileCount":54,"unpackedSize":191786,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCmYqL51o9wUN2MpgokafgXm8FRfniLyCm47Y/VwSRgOQIhAI4exMayLrxApQrAeK917NHe0P28hYehZk7O0hbA6Jwe"}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/projectz_4.0.0-next.1703642487.a4c359beaaaea1bb5e91f1e9f4693fa7c0a685f4_1703642488817_0.41936123643697965"},"_hasShrinkwrap":false},"4.0.0":{"title":"Projectz","name":"projectz","version":"4.0.0","license":"Artistic-2.0","description":"Stop wasting time syncing and updating your project's README and Package Files!","homepage":"https://github.com/bevry/projectz","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/projectz.git"},"bugs":{"url":"https://github.com/bevry/projectz/issues"},"keywords":["badges","bower","bower.json","browserify","build","buildtool","component","component.json","documentation","es2022","generator","jquery.json","jspm","license","markdown","meta","metabuild","node","package.json","project","readme","typed","types","typescript"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"projectz","githubSlug":"bevry/projectz","npmPackageName":"projectz"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your project's package files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your package files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [deno](https://deno.land)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz\",\n \"posttest\": \"projectz\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Package Files\n\nProjectz helps you maintain the following package files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple package files, you may find defining a `projectz.json` package file will help, as it can serve as a central location for the configuration of all the other files. However, if you only require one package file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd \n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io/) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io/)\n- [entroniq](https://gitlab.com/entroniq)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://bevry.me)\n- [Mohammed Shah](https://github.com/smashah)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"a6d5603d27eadb0ed6a61659f855cd9615268e09","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-JkNid6O9XLPtO2k0Tjrv+O7fkl0vIjDB99dvvrPCLw9N+stGlA3NmR2T2SEdOH28QX/81BwFoWdYnGizr5/AZg==","shasum":"2052eaa888f26cab90c9dc760e79e42a21e8ad7f","tarball":"https://registry.npmjs.org/projectz/-/projectz-4.1.0-next.1703701346.a6d5603d27eadb0ed6a61659f855cd9615268e09.tgz","fileCount":54,"unpackedSize":191574,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCQz55ABTDCLdKE9N8y4HMzgtdG+XqziXwppV4gwbDj0gIgU91t4HxkKkcZvx4ikNVCBatW7y9J44Nf8HXNsfC7TzY="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/projectz_4.1.0-next.1703701346.a6d5603d27eadb0ed6a61659f855cd9615268e09_1703701347923_0.28510895805014314"},"_hasShrinkwrap":false},"4.1.1-next.1703774159.266c619190ab162f57cf300bce8c98033ccfa4ea":{"title":"Projectz","name":"projectz","version":"4.1.1-next.1703774159.266c619190ab162f57cf300bce8c98033ccfa4ea","license":"Artistic-2.0","description":"Stop wasting time syncing and updating your project's README and Package Files!","homepage":"https://github.com/bevry/projectz","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/projectz.git"},"bugs":{"url":"https://github.com/bevry/projectz/issues"},"keywords":["badges","bower","bower.json","browserify","build","buildtool","component","component.json","documentation","es2022","generator","jquery.json","jspm","license","markdown","meta","metabuild","node","package.json","project","readme","typed","types","typescript"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"projectz","githubSlug":"bevry/projectz","npmPackageName":"projectz"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your project's package files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your package files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [deno](https://deno.land)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz\",\n \"posttest\": \"projectz\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Package Files\n\nProjectz helps you maintain the following package files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple package files, you may find defining a `projectz.json` package file will help, as it can serve as a central location for the configuration of all the other files. However, if you only require one package file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd \n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Armen Mkrtchian](https://mogoni.dev)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io)\n- [dr.dimitru](https://veliovgroup.com)\n- [Elliott Ditman](https://elliottditman.com)\n- [entroniq](https://gitlab.com/entroniq)\n- [GitHub](https://github.com/about)\n- [Hunter Beast](https://cryptoquick.com)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://mdm.cc)\n- [Michael Harry Scepaniak](https://michaelscepaniak.com)\n- [Mohammed Shah](https://github.com/smashah)\n- [Mr. Henry](https://mrhenry.be)\n- [Nermal](https://arjunaditya.vercel.app)\n- [Pleo](https://www.pleo.io)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Robert de Forest](https://github.com/rdeforest)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n- [WriterJohnBuck](https://github.com/WriterJohnBuck)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"266c619190ab162f57cf300bce8c98033ccfa4ea","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-ntq1KHH/DfCMKFWi246fnGAVQI1UDBR119cW9wI2Xsro3SFlybcHemh6OTTqPnCaj0LUHXy1Z/7vO2WcR28QFw==","shasum":"5c6f68ab220d3797a9d6b2a1a9b401f4b292c8a6","tarball":"https://registry.npmjs.org/projectz/-/projectz-4.1.1-next.1703774159.266c619190ab162f57cf300bce8c98033ccfa4ea.tgz","fileCount":54,"unpackedSize":193489,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC0LhzpCBH/VQ6uvbMJZ4zgW3W3LtyB+8HzslmVvxxVXAIgBrZM6GaeHrUPLmW0OhYpoDzPc/s+nFKJZL7opd073kU="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/projectz_4.1.1-next.1703774159.266c619190ab162f57cf300bce8c98033ccfa4ea_1703774173824_0.20568265262792673"},"_hasShrinkwrap":false},"4.1.1":{"title":"Projectz","name":"projectz","version":"4.1.1","license":"Artistic-2.0","description":"Stop wasting time syncing and updating your project's README and Package Files!","homepage":"https://github.com/bevry/projectz","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/projectz.git"},"bugs":{"url":"https://github.com/bevry/projectz/issues"},"keywords":["badges","bower","bower.json","browserify","build","buildtool","component","component.json","documentation","es2022","generator","jquery.json","jspm","license","markdown","meta","metabuild","node","package.json","project","readme","typed","types","typescript"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"projectz","githubSlug":"bevry/projectz","npmPackageName":"projectz"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [802 repositories](https://github.com/bevry/projectz/network/dependents) and [348 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2936 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your project's package files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your package files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [deno](https://deno.land)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz\",\n \"posttest\": \"projectz\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Package Files\n\nProjectz helps you maintain the following package files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple package files, you may find defining a `projectz.json` package file will help, as it can serve as a central location for the configuration of all the other files. However, if you only require one package file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd \n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Armen Mkrtchian](https://mogoni.dev)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io)\n- [dr.dimitru](https://veliovgroup.com)\n- [Elliott Ditman](https://elliottditman.com)\n- [entroniq](https://gitlab.com/entroniq)\n- [GitHub](https://github.com/about)\n- [Hunter Beast](https://cryptoquick.com)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://mdm.cc)\n- [Michael Harry Scepaniak](https://michaelscepaniak.com)\n- [Mohammed Shah](https://github.com/smashah)\n- [Mr. Henry](https://mrhenry.be)\n- [Nermal](https://arjunaditya.vercel.app)\n- [Pleo](https://pleo.io)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Robert de Forest](https://github.com/rdeforest)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n- [WriterJohnBuck](https://github.com/WriterJohnBuck)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"91073e98ce816eb6a79918605c7e4bde5525497d","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-cfCz3Itsl4LRuGOUUz2WaRJBHuFso83V63La/1NlDFT7dG9xhlT////z7uSi3iUw0ONUKvGOILj0Z44DkJy8Og==","shasum":"86c21f3a3d2168f3b47afe185d383b50986feee2","tarball":"https://registry.npmjs.org/projectz/-/projectz-4.2.0-next.1703875675.91073e98ce816eb6a79918605c7e4bde5525497d.tgz","fileCount":54,"unpackedSize":193473,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDIBd3UpU+kVHvhZqhDfu/Ur3rZaOFbYAb0bY9lky4vAAiEAlR1sLexplznGjXmWDaS9k/2hvjXBeINCkg9Kk7OfeEE="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/projectz_4.2.0-next.1703875675.91073e98ce816eb6a79918605c7e4bde5525497d_1703875719541_0.4475366577028357"},"_hasShrinkwrap":false},"4.2.0-next.1704318061.73e9753c4b34157f361c1ea0087b88dcfbb683f0":{"title":"Projectz","name":"projectz","version":"4.2.0-next.1704318061.73e9753c4b34157f361c1ea0087b88dcfbb683f0","license":"Artistic-2.0","description":"Stop wasting time syncing and updating your project's README and Package Files!","homepage":"https://github.com/bevry/projectz","funding":"https://bevry.me/fund","repository":{"type":"git","url":"git+https://github.com/bevry/projectz.git"},"bugs":{"url":"https://github.com/bevry/projectz/issues"},"keywords":["badges","bower","bower.json","browserify","build","buildtool","component","component.json","documentation","es2022","generator","jquery.json","jspm","license","markdown","meta","metabuild","node","package.json","project","readme","typed","types","typescript"],"badges":{"list":["githubworkflow","npmversion","npmdownloads","---","githubsponsors","thanksdev","patreon","liberapay","buymeacoffee","opencollective","crypto","paypal","---","discord","twitch"],"config":{"githubWorkflow":"bevry","githubSponsorsUsername":"balupton","thanksdevGithubUsername":"bevry","buymeacoffeeUsername":"balupton","cryptoURL":"https://bevry.me/crypto","flattrUsername":"balupton","liberapayUsername":"bevry","opencollectiveUsername":"bevry","patreonUsername":"bevry","paypalURL":"https://bevry.me/paypal","wishlistURL":"https://bevry.me/wishlist","discordServerID":"1147436445783560193","discordServerInvite":"nQuXddV7VP","twitchUsername":"balupton","githubUsername":"bevry","githubRepository":"projectz","githubSlug":"bevry/projectz","npmPackageName":"projectz"}},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"authors":["Benjamin Lupton \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\nStop wasting time syncing and updating your project's README and Package Files!\n\n\n\n\nThis far, projectz is used directly by [1062 repositories](https://github.com/bevry/projectz/network/dependents) and [421 packages](https://github.com/bevry/projectz/network/dependents?dependent_type=PACKAGE), and indirectly by [2989 repositories](https://libraries.io/npm/projectz/dependent-repositories) and [349 packages](https://libraries.io/npm/projectz/dependents).\n\n[Watch the talk.](https://youtu.be/IAB8_UlcNWI)\n\nHere's some of the things it can do:\n\n- [Keep your project's package files synchronised appropriately](https://github.com/bevry/projectz#data-files), supports:\n - `package.json`\n - `bower.json`\n - `component.json`\n - `jquery.json`\n- [Create beautiful standardised readme files that stay in sync with your package files](https://github.com/bevry/projectz#readme-files), supports:\n - `README`\n - `CONTRIBUTING`\n - `LICENSE`\n - `BACKERS`\n - `HISTORY`\n- Automatic injection of the appropriate installation methods, supports:\n - [npm](https://www.npmjs.com)\n - [deno](https://deno.land)\n - [jspm](http://jspm.io)\n - [Component](http://github.com/component/component)\n - [Bower](http://bower.io/)\n - [Editions](https://github.com/bevry/editions)\n - [DocPad](https://docpad.org) Plugins\n- Automatic injection of your desired [badges](https://github.com/bevry/badges)\n- Automatic injection of your [SPDX](http://spdx.org/licenses/) license information\n- Keep your data and readme files up to date with remote data, supports:\n - Pulling in your latest contributors from GitHub\n - Pulling in your latest sponsors from remote APIs ([coming soon](https://github.com/bevry/projectz/issues/80))\n\n## Running Projectz\n\n### Directly\n\nOnce installed locally, you can compile your project using projectz by running the following in your terminal:\n\n```shell\nnpx projectz\n```\n\n### Automatically\n\nTo make projectz more automatic, we recommended adding the direct command above to your build tool.\n\nIf you don't use a build tool, but do use npm, then you can add the following to your project's `package.json` file:\n\n```json\n{\n \"scripts\": {\n \"compile\": \"projectz\",\n \"posttest\": \"projectz\"\n }\n}\n```\n\nThe `compile` script here is runnable via the command `npm run-script compile` and will compile your project with projectz.\n\nThe `posttest` script here automatically compiles your project with projectz after your tests have successfully completed, providing you use `npm test` to run your tests. This is a great place to put projectz as projectz only updates meta documents so won't affect your test, and will always run before a publish.\n\n### GitHub Rate Limiting\n\nIf you get a rate limit warning, you will need to add `GITHUB_ACCESS_TOKEN` (or a `GITHUB_CLIENT_ID` AND `GITHUB_CLIENT_SECRET` combination) to your environment. To do this:\n\n1. Create a personal access token for your computer at: https://github.com/settings/tokens\n2. Projectz needs the readonly/access permissions for repos and users\n3. Generate the token and copy it\n4. Inside your dotfile profile (`.bashrc`, `.zshrc`) add `export GITHUB_ACCESS_TOKEN=\"the token value\"`\n5. Open a new shell, or run `export GITHUB_ACCESS_TOKEN=\"the token value\"` in your current shell\n6. Run projectz again\n\n## Configuring Projectz\n\n### Package Files\n\nProjectz helps you maintain the following package files:\n\n- `package.json`\n- `bower.json`\n- `component.json`\n- `jquery.json`\n\nIt does this by reading them, combining their data in memory, and then outputting the appropriate fields and over-rides for each file.\n\nIf you are making use of multiple package files, you may find defining a `projectz.json` package file will help, as it can serve as a central location for the configuration of all the other files. However, if you only require one package file, then you can ignore this ability.\n\nProjectz takes notes of these meta data fields:\n\n```javascript\n{\n // Specify your project's human readable name\n \"title\": \"Projectz\",\n\n // Specify your project name\n \"name\": \"projectz\",\n\n // Specify your project's Website URL\n \"homepage\": \"https://github.com/bevry/projectz\",\n\n // Specify your project's demo URL\n // If this is missing, and `homepage` is set, we set it to the `homepage` value\n \"demo\": \"https://github.com/bevry/projectz\",\n\n // Specify your project description\n \"description\": \"Stop wasting time syncing and updating your project's README and Package Files!\",\n\n // Specify your project's SPDX License\n // Uses https://www.npmjs.com/packages/spdx for parsing\n \"license\": \"MIT\",\n\n // Specify your whether the project can run on the client-side in web browsers\n // If this is missing, and the component or bower package files exist, then this becomes `true`\n \"browsers\": true,\n\n // Specify your project's author details\n // Can be an array or CSV string\n \"author\": \"2013+ Bevry Pty Ltd \n\n\n\n\n\n\n\n\n#### Sponsors\n\n- [Andrew Nesbitt](https://nesbitt.io) — Software engineer and researcher\n- [Balsa](https://balsa.com) — We're Balsa, and we're building tools for builders.\n- [Codecov](https://codecov.io) — Empower developers with tools to improve code quality and testing.\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Sentry](https://sentry.io) — Real-time crash reporting for your web apps, mobile apps, and games.\n- [Syntax](https://syntax.fm) — Syntax Podcast\n\n#### Donors\n\n- [Andrew Nesbitt](https://nesbitt.io)\n- [Armen Mkrtchian](https://mogoni.dev)\n- [Balsa](https://balsa.com)\n- [Chad](https://opencollective.com/chad8)\n- [Codecov](https://codecov.io)\n- [dr.dimitru](https://veliovgroup.com)\n- [Elliott Ditman](https://elliottditman.com)\n- [entroniq](https://gitlab.com/entroniq)\n- [GitHub](https://github.com/about)\n- [Hunter Beast](https://cryptoquick.com)\n- [Jean-Luc Geering](https://github.com/jlgeering)\n- [Michael Duane Mooring](https://mdm.cc)\n- [Michael Harry Scepaniak](https://michaelscepaniak.com)\n- [Mohammed Shah](https://github.com/smashah)\n- [Mr. Henry](https://mrhenry.be)\n- [Nermal](https://arjunaditya.vercel.app)\n- [Pleo](https://pleo.io)\n- [Poonacha Medappa](https://poonachamedappa.com)\n- [Rob Morris](https://github.com/Rob-Morris)\n- [Robert de Forest](https://github.com/rdeforest)\n- [Sentry](https://sentry.io)\n- [ServieJS](https://github.com/serviejs)\n- [Skunk Team](https://skunk.team)\n- [Syntax](https://syntax.fm)\n- [WriterJohnBuck](https://github.com/WriterJohnBuck)\n\n\n\n\n\n## License\n\nUnless stated otherwise all works are:\n\n- Copyright © [Benjamin Lupton](https://balupton.com)\n\nand licensed under:\n\n- [Artistic License 2.0](http://spdx.org/licenses/Artistic-2.0.html)\n\n\n","readmeFilename":"README.md","gitHead":"73e9753c4b34157f361c1ea0087b88dcfbb683f0","_nodeVersion":"20.10.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-7WbmNSCGfwkoXH7SO+Fd/fDyRas11PseoQcXLzRYNLpZGa/kdXCpg+lzzMWtUGOnZN6X5EiXdjbm6GbBTuP6zw==","shasum":"63cc6339b82cf6252bfc5501abd2dad58a8e2d6c","tarball":"https://registry.npmjs.org/projectz/-/projectz-4.2.0-next.1704318061.73e9753c4b34157f361c1ea0087b88dcfbb683f0.tgz","fileCount":54,"unpackedSize":193474,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDZckIhBWXt2ddrAS4yS+Yk2jBKwjjbP7M8gxiJwQCGEwIgHdEGa+KyLvl9irXIsL/fvaRG0LjQ8lw5HH412OxStIA="}]},"_npmUser":{"name":"bevryme","email":"us@bevry.me"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/projectz_4.2.0-next.1704318061.73e9753c4b34157f361c1ea0087b88dcfbb683f0_1704318084729_0.2320691247556228"},"_hasShrinkwrap":false}},"readme":"","maintainers":[{"name":"bevryme","email":"us@bevry.me"}],"time":{"modified":"2024-01-03T21:41:25.090Z","created":"2013-09-18T15:38:55.950Z","0.0.1":"2013-09-18T15:39:00.653Z","0.1.0":"2013-10-15T07:02:19.137Z","0.2.0":"2013-10-16T05:24:19.178Z","0.2.1":"2013-10-16T06:17:10.032Z","0.2.2":"2013-10-23T05:12:25.626Z","0.2.3":"2013-10-23T05:22:51.376Z","0.2.4":"2013-10-31T04:00:01.914Z","0.2.5":"2013-10-31T04:03:00.804Z","0.2.6":"2013-11-06T12:46:48.174Z","0.2.7":"2013-11-25T13:56:26.963Z","0.2.8":"2013-12-12T02:35:15.533Z","0.2.9":"2013-12-12T02:41:39.146Z","0.2.10":"2013-12-12T02:43:53.847Z","0.3.0":"2013-12-12T03:13:46.538Z","0.3.1":"2013-12-16T08:15:35.909Z","0.3.2":"2013-12-16T08:17:44.677Z","0.3.3":"2014-01-01T03:31:43.331Z","0.3.4":"2014-01-01T03:42:52.019Z","0.3.5":"2014-01-01T04:09:00.095Z","0.3.6":"2014-01-02T14:14:06.739Z","0.3.7":"2014-01-03T01:49:49.734Z","0.3.8":"2014-01-06T23:59:44.709Z","0.3.9":"2014-01-07T00:02:56.568Z","0.3.10":"2014-02-06T01:33:04.914Z","0.3.11":"2014-02-19T09:02:12.867Z","0.3.12":"2014-05-17T10:07:12.242Z","0.3.13":"2014-05-17T10:37:20.924Z","0.3.14":"2014-05-30T14:43:22.669Z","0.3.15":"2014-06-23T17:05:43.882Z","0.3.16":"2014-12-11T03:41:43.362Z","0.3.17":"2014-12-11T03:57:31.337Z","0.4.0":"2015-02-09T10:38:00.612Z","0.4.1":"2015-02-09T15:29:11.563Z","0.4.2":"2015-02-11T01:46:18.092Z","0.4.3":"2015-02-13T12:25:47.724Z","0.5.0":"2015-02-24T10:54:42.310Z","1.0.0":"2015-09-16T06:48:11.863Z","1.0.1":"2015-09-16T10:24:04.197Z","1.0.2":"2015-09-18T04:08:58.420Z","1.0.3":"2015-09-20T12:21:24.263Z","1.0.4":"2015-09-20T12:24:39.796Z","1.0.5":"2015-09-21T01:18:33.391Z","1.0.6":"2015-09-21T01:32:11.884Z","1.0.7":"2015-11-30T10:17:15.881Z","1.0.8":"2015-12-07T06:00:51.311Z","1.0.9":"2015-12-10T01:03:09.598Z","1.1.0":"2016-03-20T05:57:57.728Z","1.1.1":"2016-03-20T11:39:49.299Z","1.1.2":"2016-03-20T11:42:33.941Z","1.1.3":"2016-05-01T21:43:13.666Z","1.1.4":"2016-05-01T22:24:41.954Z","1.1.5":"2016-05-03T21:28:35.792Z","1.1.6":"2016-06-07T22:58:09.992Z","1.2.0":"2016-09-19T20:04:30.631Z","1.3.0":"2016-10-19T12:26:56.613Z","1.3.1":"2016-10-23T17:04:22.349Z","1.3.2":"2016-10-23T17:47:46.857Z","1.4.0":"2017-04-09T21:06:03.511Z","1.5.0":"2018-11-15T06:01:36.399Z","1.5.1":"2018-11-15T10:44:39.010Z","1.5.2":"2018-11-15T11:14:48.093Z","1.5.3":"2018-11-15T12:32:12.424Z","1.6.0":"2018-12-19T04:11:36.118Z","1.7.0":"2018-12-19T07:33:44.295Z","1.7.1":"2018-12-19T07:40:10.215Z","1.7.2":"2018-12-19T07:44:17.641Z","1.7.3":"2018-12-19T07:50:34.264Z","1.7.4":"2018-12-22T15:01:16.087Z","1.7.5":"2019-09-10T14:24:20.243Z","1.8.0-next.1573407399.942925f4c40a4a152930e43f3694580e29bd91d6":"2019-11-10T17:36:41.548Z","1.8.0":"2019-11-10T17:39:01.764Z","1.9.0-next.1573407724.48b5b8e740708e8bf770ae44cccc95fb551f214c":"2019-11-10T17:42:05.951Z","1.9.0":"2019-11-10T17:43:21.291Z","1.9.0-next.1573415102.8312eae057c977b0ded791bc7f37a3376fda7e15":"2019-11-10T19:45:04.481Z","1.9.0-next.1573427729.ed8f341b5cbe25d4693261108a99e9a3d62044eb":"2019-11-10T23:15:31.117Z","1.9.0-next.1573430196.a39a1fe62c55c90e2ffbdb659e1978f5a8ec233c":"2019-11-10T23:56:39.095Z","1.9.0-next.1573528967.dc0576aae0a10082ebd1aaf574390d5a790ad515":"2019-11-12T03:22:49.498Z","1.9.0-next.1573587953.df24991a90e5a7dfce7a0215c0e780aedadec154":"2019-11-12T19:45:56.013Z","1.9.0-next.1573594024.1318cdb56e2d25b8987df27735b8cd4684f433ce":"2019-11-12T21:27:05.753Z","1.9.0-next.1573597906.a0f9d396b2256920e3915df0bdefbfaf5ee36509":"2019-11-12T22:31:48.565Z","1.10.0-next.1573609931.16047bb1607079adca150fb8843b76a8a0e86fe4":"2019-11-13T01:52:13.342Z","1.10.0":"2019-11-13T01:52:49.442Z","1.10.0-next.1573616140.83d1a70b368ace9638c17ec98e74bff4ed93e472":"2019-11-13T03:35:42.750Z","1.11.0-next.1574056394.66e10432946307892d3c7c2a659dd516a599b50f":"2019-11-18T05:53:16.283Z","1.11.0":"2019-11-18T05:54:28.568Z","1.12.0-next.1574081052.366bd8b3a0af982ec4fd3b6ab37ee301328af513":"2019-11-18T12:44:18.552Z","1.12.0":"2019-11-18T12:45:33.327Z","1.12.0-next.1574637357.3bcc70b4079cd1133d02397f96f6812041eddef8":"2019-11-24T23:16:13.367Z","1.13.0-next.1575153340.20fb0fb275c58dfba13cb882adc3f555491a906c":"2019-11-30T22:35:42.553Z","1.13.0":"2019-11-30T22:36:55.489Z","1.14.0-next.1575218291.79db151d475b62ce28641862d6cb485f8437657e":"2019-12-01T16:38:13.056Z","1.14.0":"2019-12-01T16:38:53.040Z","1.15.0-next.1575629681.b6cf6a991bfa7121c48f09a77930cbff4665f13f":"2019-12-06T10:54:42.772Z","1.15.0":"2019-12-06T10:55:41.609Z","1.16.0-next.1575917505.c0b30d0b06c18797c9899298c50812d9c7d53d1e":"2019-12-09T18:51:54.045Z","1.16.0":"2019-12-09T18:53:11.153Z","1.16.0-next.1576060367.46e926cfff10ce2a4346c0246fba5627bbb87a03":"2019-12-11T10:32:49.431Z","1.17.0-next.1576614140.738d212cf18885f32f5a12cc6291119d3b5f3540":"2019-12-17T20:22:21.639Z","1.17.0":"2019-12-17T20:23:22.808Z","1.17.0-next.1576614275.c836f6a5a54f180da829b47d5d911bc9317418f1":"2019-12-17T20:24:37.103Z","1.17.0-next.1576614761.3aefbe80e399c56219ad9873cef0596287335c94":"2019-12-17T20:32:43.610Z","1.17.1-next.1576625949.73955e41aae2c3161e4cad320b9d6565296f1f71":"2019-12-17T23:39:10.606Z","1.17.1":"2019-12-17T23:40:20.358Z","1.18.0-next.1576628921.28b6e9e5ac73c411a48413b684155b4a316dcd09":"2019-12-18T00:28:42.576Z","1.18.0":"2019-12-18T00:29:58.436Z","1.19.0-next.1576630937.b290279f6d92c5005353f85cbaa6a70a59f48bcf":"2019-12-18T01:02:18.695Z","1.19.0":"2019-12-18T01:03:12.274Z","1.19.0-next.1584138094.3737ecdb4f4d5b074c849b98a5e492586571d340":"2020-03-13T22:21:35.628Z","1.19.1-next.1587462191.f9ecd41a1a56d9f960aaf3e06125c69d933f05b5":"2020-04-21T09:43:13.079Z","1.19.1":"2020-04-21T09:43:22.228Z","2.0.0-next.1588944480.8be4a8eb8521d70e0006b4d3f03e949fdc359714":"2020-05-08T13:28:01.933Z","2.0.0-next.1588944599.f210f28ccab8f1a6f960c4f4a4e81d749af46b32":"2020-05-08T13:30:01.324Z","2.0.0":"2020-05-08T13:38:08.998Z","2.1.0-next.1589185122.62bd71f08decef82b282ccf7b3af620c22d21926":"2020-05-11T08:18:43.939Z","2.1.0":"2020-05-11T08:18:53.913Z","2.2.0-next.1590006266.ed212575c695d3850f5c90ab096ff21133ed4fef":"2020-05-20T20:24:28.047Z","2.2.0":"2020-05-20T20:24:41.549Z","2.3.0-next.1590062887.2773e056ad8c568754fe4a81330b108152568cc5":"2020-05-21T12:08:09.238Z","2.3.0":"2020-05-21T12:08:39.975Z","2.4.0-next.1590079971.07531e9e36d80648e2d51c54d6c7c70d76921a85":"2020-05-21T16:52:53.713Z","2.4.0":"2020-05-21T16:53:04.465Z","2.5.0-next.1591771424.3029f8d32eac910079c42190252b7376d10384fa":"2020-06-10T06:43:46.226Z","2.5.0":"2020-06-10T06:43:50.075Z","2.6.0-next.1591784733.491092462f7c9c4397cb3a16bb0ecd0f5365efcd":"2020-06-10T10:25:34.717Z","2.6.0":"2020-06-10T10:25:46.368Z","2.7.0-next.1591800711.060c27cc7c4711edecf2c0839e7e253cd19ed72f":"2020-06-10T14:51:53.771Z","2.7.0":"2020-06-10T14:52:04.997Z","2.8.0-next.1592634557.a7d24ad285c337923058549f311cd696a4eba3d7":"2020-06-20T06:29:19.124Z","2.9.0-next.1592728617.45014f5af3b3ed7331298b2a8282ac6667248d32":"2020-06-21T08:36:59.995Z","2.9.0":"2020-06-21T08:37:15.875Z","2.10.0-next.1592763240.832a434a1889e069344cb5df172b2795f5d97a13":"2020-06-21T18:14:03.025Z","2.10.0":"2020-06-21T18:14:09.794Z","2.10.0-next.1593022893.0bb950e72175885c34e5f8d9494e3ade4e95ac88":"2020-06-24T18:21:35.886Z","2.10.1":"2020-06-24T18:51:43.271Z","2.10.1-next.1593024705.6c0d672d2da22bf4e236a9a9ec94be9e88a8bc5f":"2020-06-24T18:52:04.582Z","2.10.1-next.1593046334.d3c827a74c7186c96e62c1a2749fd05e5f8b4ddc":"2020-06-25T00:52:16.544Z","2.11.0-next.1593058930.659dbe496de2fe040d2d9f7581528d151704d15e":"2020-06-25T04:22:11.834Z","2.11.0":"2020-06-25T04:22:16.816Z","2.12.0-next.1595430098.efd72fd62b6f19326bd897169249820e8a8d65b1":"2020-07-22T15:01:40.160Z","2.12.0":"2020-07-22T15:01:58.910Z","2.13.0-next.1596522013.8bdaa8ed657d79daf0b33f09a131772cd54c471f":"2020-08-04T06:20:15.590Z","2.13.0":"2020-08-04T06:20:27.393Z","2.14.0-next.1597467202.10bbcf8e961b246539ef2d87a992df28e7b1d560":"2020-08-15T04:53:24.537Z","2.14.0":"2020-08-15T04:53:36.073Z","2.14.0-next.1597643724.29faa89d60c773b3c390059aa3f85ce570e17d88":"2020-08-17T05:55:25.582Z","2.15.0-next.1597700616.1618acd3d42344d0e15b0904b1dec341e8e8b452":"2020-08-17T21:43:38.176Z","2.15.0":"2020-08-17T21:43:44.293Z","2.15.0-next.1598189029.7edf7b68b3c37bfe75c24914c5a02803cd817f02":"2020-08-23T13:23:50.978Z","2.15.0-next.1598779204.82cc5cdf3d6b023b241ad51ec857cc41617a5c3a":"2020-08-30T09:20:05.926Z","2.15.0-next.1599076612.c25f735b0123d6388a571184a548c501ed701806":"2020-09-02T19:56:53.820Z","2.16.0-next.1599274600.952d23070fcc17a31065e7c00e217bb09ce388b5":"2020-09-05T02:56:42.388Z","2.16.0":"2020-09-05T02:56:53.455Z","2.16.0-next.1599397020.2fbf22aad3f28428f8af84524864b5aa6ba57b9d":"2020-09-06T12:57:01.912Z","2.16.0-next.1599993896.d5a1dc83e26b807a67fec9b5a394ce0cd1ce1a90":"2020-09-13T10:44:59.136Z","2.16.0-next.1599998417.da6bc2318ee6366951cf8fdb3ab02a89d318cfdf":"2020-09-13T12:00:19.476Z","2.16.0-next.1601214271.4ece9f6e11eed0e44997e5ead4b4b6337697fbc7":"2020-09-27T13:44:32.954Z","2.16.0-next.1601796972.53f0d429d9cdb366c95a8cc051a9a13938d588e3":"2020-10-04T07:36:13.576Z","2.16.0-next.1601800405.b7b117240ceefa259c221d4996e5993eee7e91bd":"2020-10-04T08:33:26.917Z","2.16.0-next.1602405741.2c5bf71202fe6eac6cc310dee34b1a50e89ec038":"2020-10-11T08:42:23.315Z","2.16.0-next.1602412527.aef55ad313345bf244139f5eab2f90a9d177cf36":"2020-10-11T10:35:29.440Z","2.16.0-next.1603015813.42c9adc871c6ced49462ea556ce7f8205848a2e0":"2020-10-18T10:10:15.607Z","2.16.0-next.1603623122.a781af52e9a53fc350c585e9ded9037ed9039c30":"2020-10-25T10:52:04.020Z","2.16.0-next.1603630342.26e3f7accc5796a3bb5cd48b694e1230b10526a9":"2020-10-25T12:52:23.734Z","2.16.0-next.1603919094.145800b369fd83e84635fc937e6c9d1c2bdda232":"2020-10-28T21:04:56.476Z","2.17.0-next.1603941002.5b924cb343c98c0fc7fcecfe304b46e51ac62bba":"2020-10-29T03:10:03.869Z","2.17.0":"2020-10-29T03:10:14.343Z","2.17.0-next.1604235573.111a4d03ecf1d25991b52b944bdf1f54ec8fc892":"2020-11-01T12:59:34.984Z","2.18.0":"2020-11-23T05:40:37.148Z","2.18.0-next.1606110048.d636ae11a909966134fab36bf5e0884ea2828718":"2020-11-23T05:40:50.399Z","2.19.0":"2021-07-28T21:39:01.631Z","2.20.0-next.1627583579.f95e1517700b203d384b5ce6bf8535478c8d4b62":"2021-07-29T18:33:01.141Z","2.20.0":"2021-07-29T18:33:25.924Z","2.21.0":"2021-07-29T19:37:42.785Z","2.21.0-next.1627587498.97e2642ce2e4e87a816b8e62cb8c25a7e64d7daa":"2021-07-29T19:38:20.738Z","2.22.0":"2021-07-29T23:11:01.047Z","2.22.0-next.1627600263.0fe1176cd1f3d52890ffbf554599a81d7c10a1f1":"2021-07-29T23:11:05.307Z","2.23.0":"2023-03-24T07:08:07.834Z","2.23.0-next.1679641709.b958c463dbcb9f0b1453200b66c95604831cd502":"2023-03-24T07:08:31.925Z","3.0.0":"2023-11-14T09:15:29.011Z","3.0.0-next.1699953336.1bbb9cd3e8efeda03a1a30dde80b2a9cd3f12a3e":"2023-11-14T09:15:38.625Z","3.1.0":"2023-11-15T07:02:17.660Z","3.1.0-next.1700031758.e7e1dcc86748c99750b5fc60d4633c8143c03dd8":"2023-11-15T07:02:40.880Z","3.2.0-next.1700276310.283b9b73274d9e292b3807333caaba40273736f0":"2023-11-18T02:58:31.756Z","3.2.0":"2023-11-18T02:59:47.566Z","3.3.0-next.1700571576.c8e070d5ff78d80ab16aefdc9f4016571ba043ad":"2023-11-21T12:59:38.380Z","3.3.0":"2023-11-21T13:00:24.193Z","3.4.0":"2023-11-24T20:33:56.994Z","3.4.0-next.1700858038.9ca628333e5921eac920413a5bd6f98caa19b5d3":"2023-11-24T20:33:59.928Z","4.0.0-next.1703642487.a4c359beaaaea1bb5e91f1e9f4693fa7c0a685f4":"2023-12-27T02:01:28.999Z","4.0.0":"2023-12-27T02:02:05.166Z","4.1.0":"2023-12-27T18:22:10.676Z","4.1.0-next.1703701346.a6d5603d27eadb0ed6a61659f855cd9615268e09":"2023-12-27T18:22:28.159Z","4.1.1-next.1703774159.266c619190ab162f57cf300bce8c98033ccfa4ea":"2023-12-28T14:36:13.980Z","4.1.1":"2023-12-28T14:36:53.510Z","4.2.0":"2023-12-29T18:48:11.768Z","4.2.0-next.1703875675.91073e98ce816eb6a79918605c7e4bde5525497d":"2023-12-29T18:48:39.728Z","4.2.0-next.1704318061.73e9753c4b34157f361c1ea0087b88dcfbb683f0":"2024-01-03T21:41:24.904Z"},"author":{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},"repository":{"type":"git","url":"git+https://github.com/bevry/projectz.git"},"readmeFilename":"","homepage":"https://github.com/bevry/projectz","keywords":["badges","bower","bower.json","browserify","build","buildtool","component","component.json","documentation","es2022","generator","jquery.json","jspm","license","markdown","meta","metabuild","node","package.json","project","readme","typed","types","typescript"],"contributors":[{"name":"Benjamin Lupton","email":"b@lupton.cc","url":"https://balupton.com"},{"name":"James George","email":"jamesgeorge998001@gmail.com","url":"https://github.com/jamesgeorge007"},{"name":"Oliver Lorenz","url":"https://oliverlorenz.com"},{"name":"Peter C","email":"peterkc@gmail.com","url":"https://linkedin.com/in/peterkc1"},{"name":"Peter Flannery","url":"https://github.com/pflannery"},{"name":"Rob Loach","email":"robloach@gmail.com","url":"https://robloach.net"},{"name":"Shahar \"Dawn\" Or","email":"mightyiampresence@gmail.com","url":"https://github.com/mightyiam"},{"name":"vsopvsop","url":"https://github.com/vsopvsop"},{"name":"Zearin","url":"https://github.com/Zearin"},{"name":"Zlatan Vasović","email":"zlatanvasovic@gmail.com","url":"https://github.com/zlatanvasovic"}],"bugs":{"url":"https://github.com/bevry/projectz/issues"},"license":"Artistic-2.0","users":{"leesei":true,"majgis":true,"balupton":true}}