xen-orchestra

History

Julien Fontanet a624330818 fix(usage-to-readme): fix multiple .USAGE.md changes		2024-01-19 10:23:52 +01:00
..
_computeDepOrder.js	fix(scripts/gen-deps-list): fix peer dependencies order	2023-03-06 11:05:23 +01:00
babel-eslintrc.js	fix(xo-web/backup/restore): don't use `UNSAFE_componentWillReceiveProps` (#6364 )	2022-08-11 11:19:07 +02:00
benchmarks.js	chore(scripts): add .js suffix for better Prettier/ESLint integration	2022-04-08 14:14:41 +02:00
bump-pkg	fix(scripts/bump-pkg): fix npm Cannot set properties of null (setting 'parent') error	2023-03-06 17:23:59 +01:00
gen-deps-list.js	feat(gen-deps-list): detect duplicate packages	2023-12-07 17:15:09 +01:00
import-packages	fix(import-packages): force merge (--no-ff)	2019-07-17 16:30:54 +02:00
normalize-packages.js	feat(lint-staged): add .USAGE.md → README.md	2024-01-18 12:34:23 +01:00
npmignore	fix(test-integration): run integration tests only in ci (#6826 )	2023-05-11 17:47:48 +02:00
README.md.tpl	docs: uniformize code blocks	2023-02-06 11:25:12 +01:00
run-changed-pkgs.js	feat: run test script for all pkgs with changed files	2022-11-22 17:30:14 +01:00
run-script.js	feat: run-script.js now only shows output on error by default	2022-11-25 15:45:52 +01:00
run.js	chore(scripts): add .js suffix for better Prettier/ESLint integration	2022-04-08 14:14:41 +02:00
usage-to-readme.js	fix(usage-to-readme): fix multiple .USAGE.md changes	2024-01-19 10:23:52 +01:00
utils.js	feat: limit concurrency of root build script	2022-11-10 18:09:05 +01:00

README.md.tpl

<!-- DO NOT EDIT MANUALLY, THIS FILE HAS BEEN GENERATED -->

# {{pkg.name}}

{{#unless pkg.private}}
[![Package Version](https://badgen.net/npm/v/{{pkg.name}})](https://npmjs.org/package/{{pkg.name}}) ![License](https://badgen.net/npm/license/{{pkg.name}}) [![PackagePhobia](https://badgen.net/bundlephobia/minzip/{{pkg.name}})](https://bundlephobia.com/result?p={{pkg.name}}) [![Node compatibility](https://badgen.net/npm/node/{{pkg.name}})](https://npmjs.org/package/{{pkg.name}})

{{/unless}}
{{#if pkg.description}}
> {{pkg.description}}

{{/if}}
{{#unless pkg.private}}
## Install

Installation of the [npm package](https://npmjs.org/package/{{pkg.name}}):

```sh
npm install --{{#if pkg.preferGlobal}}global{{^}}save{{/if}} {{pkg.name}}
```

{{/unless}}
{{#if usage}}
## Usage

{{{usage}}}

{{/if}}
## Contributions

Contributions are _very_ welcomed, either on the documentation or on
the code.

You may:

- report any [issue]({{pkg.bugs}})
  you've encountered;
- fork and create a pull request.

## License

[{{pkg.license}}](https://spdx.org/licenses/{{pkg.license}}) © [{{pkg.author.name}}]({{pkg.author.url}})