From 0eefa9e5c1673e31fd9375cd69e1ed911ed16f05 Mon Sep 17 00:00:00 2001 From: Russell Banks <74878137+russellbanks@users.noreply.github.com> Date: Sun, 28 Jan 2024 13:23:08 +0000 Subject: [PATCH] Document fine-grained and classic tokens Resolves #310 --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddb47ac5..f2e5065e 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,8 @@ Komac is an advanced CLI designed to create manifests for the [WinGet Community Komac is both blazingly fast 🔥 and incredibly low on memory, using just ~3.5MB of memory on my machine. +![Komac-demo](assets/demo.gif) + ## Installation Komac is cross-platform and binaries are built for Windows, Linux, macOS, and FreeBSD. @@ -44,6 +46,22 @@ Portable binaries for macOS are available from the [releases](https://github.com brew install russellbanks/tap/komac ``` +## GitHub Token + +Komac can use either a fine-grained or classic token. + +### Fine-grained + +A fine-grained token with `Public Repositories (read only)` access. + +![firefox_f53aGTsVKX](https://github.com/russellbanks/Komac/assets/74878137/6d7414d7-b7b0-41dc-9e89-afb87b7dec53) + +### Classic + +A classic token with the `public_repo` and `read:org` scopes. + +![firefox_NiYtCiXBM1](https://github.com/russellbanks/Komac/assets/74878137/afd87dc3-e54e-4757-ad07-27affe88437e) + ## Commands | Command | Description | Usage | @@ -69,10 +87,6 @@ komac update -i Package.Identifier -v 1.2.3 --urls https://www.firstUrl.com http | Automatically submit | `--submit` | | | Token (if one is not already stored) | `--token` | Komac will check for a `GITHUB_TOKEN` environment variable | -## Komac in Action 🎥 - -![Komac-demo](assets/demo.gif) - ## Komac vs other tools 🏆 While other manifest creation tools have made remarkable strides in the winget-pkgs community, their development pace is