Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.14 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.14 KB
┓ ┳┏┓┏┓┳┓┏┓┏┓
┃ ┃┃ ┣ ┃┃┗┓┣ 
┗┛┻┗┛┗┛┛┗┗┛┗┛

A tmplr recipe to add license to your project. Provides a wide range of licenses to choose from, sourced from choosealicense.com.

Usage

👉 Use it on your project:

npx tmplr use trpcs/license

👉 Or use it as part of some other tmplr recipe:

# .tmplr.yml
steps:
  # ...

  - use: trpcs/license

  # ...

If the following arguments are provided, the recipe won't prompt the user for them:

  • owner: The full name of the license owner.
  • project_name: The name of the project. Required by some licenses (not all).
  • project_url: The url of the project. Required by some licenses (not all).
  • email: The email of the license owner. Required by some licenses (not all).
# .tmplr.yml
steps:
  - use: loreanvictor/license-recipe
    args:
      owner: "Lorean Victor"
      project_name: "My Project"
      project_url: "https://github.com/loreanvictor/my-project"