README.md

{{FRIENDLY_NAME}}

{{DESCRIPTION}}

• How to use
• Install
  • via npm
  • via OpenUPM
  • via Git URL
  • Tests
• Configuration

How to use

Work In Progress

Install

via npm

Open Packages/manifest.json with your favorite text editor. Add a scoped registry and following line to dependencies block:

{
  "scopedRegistries": [
    {
      "name": "npmjs",
      "url": "https://registry.npmjs.org/",
      "scopes": [
        "com.{{COMPANY}}"
      ]
    }
  ],
  "dependencies": {
    "com.{{COMPANY}}.{{REPOSITORY_NAME}}": "1.0.0"
  }
}

Package should now appear in package manager.

via OpenUPM

The package is also available on the openupm registry. You can install it eg. via openupm-cli.

openupm add com.{{COMPANY}}.{{REPOSITORY_NAME}}

via Git URL

Open Packages/manifest.json with your favorite text editor. Add following line to the dependencies block:

{
  "dependencies": {
    "com.{{COMPANY}}.{{REPOSITORY_NAME}}": "https://github.com/{{COMPANY}}/{{REPOSITORY_NAME}}.git"
  }
}

Tests

The package can optionally be set as testable. In practice this means that tests in the package will be visible in the Unity Test Runner.

Open Packages/manifest.json with your favorite text editor. Add following line after the dependencies block:

{
  "dependencies": {
  },
  "testables": [ "com.{{COMPANY}}.{{REPOSITORY_NAME}}" ]
}

Configuration

Work In Progress

License

MIT License

Copyright © {{YEAR}} {{COMPANY_FRIENDLY_NAME}}