|
| 1 | +# java |
| 2 | + |
| 3 | +Java language plugin for the @form8ion toolset |
| 4 | + |
| 5 | +<!--status-badges start --> |
| 6 | + |
| 7 | +[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link] |
| 8 | +[![Codecov][coverage-badge]][coverage-link] |
| 9 | +![SLSA Level 2][slsa-badge] |
| 10 | + |
| 11 | +<!--status-badges end --> |
| 12 | + |
| 13 | +## Table of Contents |
| 14 | + |
| 15 | +Run `npm run generate:md` to generate a table of contents |
| 16 | + |
| 17 | +## Usage |
| 18 | + |
| 19 | +<!--consumer-badges start --> |
| 20 | + |
| 21 | +[![MIT license][license-badge]][license-link] |
| 22 | +[![npm][npm-badge]][npm-link] |
| 23 | +[![Try @form8ion/java on RunKit][runkit-badge]][runkit-link] |
| 24 | + |
| 25 | +<!--consumer-badges end --> |
| 26 | + |
| 27 | +### Installation |
| 28 | + |
| 29 | +```sh |
| 30 | +$ npm install @form8ion/java --save |
| 31 | +``` |
| 32 | + |
| 33 | +### Example |
| 34 | + |
| 35 | +run `npm run generate:md` to inject the usage example |
| 36 | + |
| 37 | +## Contributing |
| 38 | + |
| 39 | +<!--contribution-badges start --> |
| 40 | + |
| 41 | +[![Commitizen friendly][commitizen-badge]][commitizen-link] |
| 42 | +[![Conventional Commits][commit-convention-badge]][commit-convention-link] |
| 43 | +[![semantic-release: angular][semantic-release-badge]][semantic-release-link] |
| 44 | +[![Renovate][renovate-badge]][renovate-link] |
| 45 | +[![PRs Welcome][PRs-badge]][PRs-link] |
| 46 | + |
| 47 | +<!--contribution-badges end --> |
| 48 | + |
| 49 | +### Dependencies |
| 50 | + |
| 51 | +```sh |
| 52 | +$ nvm install |
| 53 | +$ npm install |
| 54 | +``` |
| 55 | + |
| 56 | +### Verification |
| 57 | + |
| 58 | +```sh |
| 59 | +$ npm test |
| 60 | +``` |
| 61 | + |
| 62 | +[commitizen-link]: http://commitizen.github.io/cz-cli/ |
| 63 | + |
| 64 | +[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg |
| 65 | + |
| 66 | +[commit-convention-link]: https://conventionalcommits.org |
| 67 | + |
| 68 | +[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg |
| 69 | + |
| 70 | +[semantic-release-link]: https://github.com/semantic-release/semantic-release |
| 71 | + |
| 72 | +[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release |
| 73 | + |
| 74 | +[renovate-link]: https://renovatebot.com |
| 75 | + |
| 76 | +[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot |
| 77 | + |
| 78 | +[PRs-link]: https://makeapullrequest.com |
| 79 | + |
| 80 | +[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg |
| 81 | + |
| 82 | +[github-actions-ci-link]: https://github.com/form8ion/java/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster |
| 83 | + |
| 84 | +[github-actions-ci-badge]: https://img.shields.io/github/actions/workflow/status/form8ion/java/node-ci.yml.svg?branch=master&logo=github |
| 85 | + |
| 86 | +[coverage-link]: https://codecov.io/github/form8ion/java |
| 87 | + |
| 88 | +[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/java?logo=codecov |
| 89 | + |
| 90 | +[slsa-badge]: https://slsa.dev/images/gh-badge-level2.svg |
| 91 | + |
| 92 | +[license-link]: LICENSE |
| 93 | + |
| 94 | +[license-badge]: https://img.shields.io/github/license/form8ion/java.svg |
| 95 | + |
| 96 | +[npm-link]: https://www.npmjs.com/package/@form8ion/java |
| 97 | + |
| 98 | +[npm-badge]: https://img.shields.io/npm/v/@form8ion/java?logo=npm |
| 99 | + |
| 100 | +[runkit-link]: https://npm.runkit.com/@form8ion/java |
| 101 | + |
| 102 | +[runkit-badge]: https://badge.runkitcdn.com/@form8ion/java.svg |
0 commit comments