<%# Copyright 2013-2026 the original author or authors from the JHipster project. This file is part of the JHipster project, see https://www.jhipster.tech/ for more information. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at https://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. -%> # generator-jhipster-<%= baseName %> > JHipster blueprint, <%= baseName %> blueprint for JHipster [![NPM version][npm-image]][npm-url] [![Generator][github-generator-image]][github-generator-url] [![Samples][github-samples-image]][github-samples-url] # Introduction This is a [JHipster](https://www.jhipster.tech/) blueprint, that is meant to be used in a JHipster application. # Prerequisites As this is a [JHipster](https://www.jhipster.tech/) blueprint, we expect you have JHipster basic knowledge: - [JHipster](https://www.jhipster.tech/) # Installation To install or update this blueprint: ```bash npm install -g generator-jhipster-<%= baseName %> ``` # Usage To use this blueprint, run the below command <%_ if (cli) { _%> ```bash <%= cliName %> <%_ if (caret) { _%> ``` or ```bash jhipster --blueprints <%= baseName %> ``` <%_ } _%> <%_ } else { _%> ```bash jhipster --blueprints <%= baseName %> ``` <%_ } _%> You can look for updated <%= baseName %> blueprint specific options by running ```bash <%_ if (cli) { _%> <%= cliName %> app --help <%_ } else { _%> jhipster app --blueprints <%= baseName %> --help <%_ } _%> ``` And looking for `(blueprint option: <%= baseName %>)` like ## Pre-release To use an unreleased version, install it using git. ```bash npm install -g <%= githubRepository %>#main jhipster --blueprints <%= baseName %> --skip-jhipster-dependencies ``` [npm-image]: https://img.shields.io/npm/v/generator-jhipster-<%= baseName %>.svg [npm-url]: https://npmjs.org/package/generator-jhipster-<%= baseName %> [github-generator-image]: https://github.com/<%= githubRepository %>/actions/workflows/generator.yml/badge.svg [github-generator-url]: https://github.com/<%= githubRepository %>/actions/workflows/generator.yml [github-samples-image]: https://github.com/<%= githubRepository %>/actions/workflows/samples.yml/badge.svg [github-samples-url]: https://github.com/<%= githubRepository %>/actions/workflows/samples.yml