Skip to content

tamada/plmaker

Repository files navigation

plmaker

Coverage Status

Version License

Docker Docker

Homebrew

🗣️ Overview

plmaker is an abbreviation for "Product Label Maker." This tool retrieves project information from GitHub. When creating a website to introduce related products, it is necessary to collect information about the products. However, the timing of web page creation and product updates often differ, resulting in outdated information on the website.

plmaker solves this problem by collecting product information from GitHub and providing a summary in JSON format. This collected information can be easily converted for use in websites built with popular static site generators such as Hugo, Jekyll, Hexo, and others.

🏃 Usage

🚲 CLI

Usage: plmaker [-hV] [--overwrite] [--store=STORE_TYPE] [-t=TOKEN] PROJECTs...
      PROJECTs...          The product name in GitHub. The name should form
                             OWNER/PRODUCT.
  -h, --help               Show this help message and exit.
      --overwrite          If this value is true, plmaker overwrite the
                             configuration file.
      --store=STORE_TYPE   If the value of this option is HOME or CWD, after
                             running the plmaker, store the config file to the
                             specified location. Default: NONE, Available:
                             HOME, CWD, NONE
  -t, --token=TOKEN        Specify the token for the GitHub API.  This product
                             reads GitHub token from this option value, 
                             ./.plmaker.json, and ~/.config/plmaker/config.json
                             in this order.
  -V, --version            Print version information and exit.

🐳 Docker

  • native image
    • Docker
  • Java (minimal JRE)
    • Docker
docker run -it --rm -v $PWD:/app ghcr.io/tamada/plmaker/native:0.6.0 <ARGUMENTS_FOR_PLMAKER>

⚓ Install

Package Manager

  • 🍺 Homebrew
    • Homebrew
    • brew install tamada/brew/plmaker

💪 Compiling yourself

Type the following commands, then build/libs/plmaker-0.6.0.jar will be built.

 git clone https://github.com/tamada/plmaker.git
 cd plmaker
 gradle build

😄 About

📜 License

License

👨‍💼 Developers 👩‍💼

  • Haruaki TAMADA.

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published