From f1c8a9c400efaf600a075d7bff5a71c2828c1cf4 Mon Sep 17 00:00:00 2001 From: tonghuang Date: Tue, 16 Jan 2024 14:41:14 +0800 Subject: [PATCH] docs: update README --- README.md | 53 ++++++++++++++++++----------------------------------- 1 file changed, 18 insertions(+), 35 deletions(-) diff --git a/README.md b/README.md index a53d3d7..d41f9a9 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,25 @@ -# Scoop Bucket Template +[![Tests](https://github.com/plutotree/scoop-bucket/actions/workflows/ci.yml/badge.svg)](https://github.com/plutotree/scoop-bucket/actions/workflows/ci.yml) [![Excavator](https://github.com/plutotree/scoop-bucket/actions/workflows/excavator.yml/badge.svg)](https://github.com/plutotree/scoop-bucket/actions/workflows/excavator.yml) - - +## Usage -Template bucket for [Scoop](https://scoop.sh), the Windows command-line installer. - -## How do I use this template? - -1. Generate your own copy of this repository with the "Use this template" - button. -2. Allow all GitHub Actions: - - Navigate to `Settings` - `Actions` - `General` - `Actions permissions`. - - Select `Allow all actions and reusable workflows`. - - Then `Save`. -3. Allow writing to the repository from within GitHub Actions: - - Navigate to `Settings` - `Actions` - `General` - `Workflow permissions`. - - Select `Read and write permissions`. - - Then `Save`. -4. Document the bucket in `README.md`. -5. Replace the placeholder repository string in `bin/auto-pr.ps1`. -6. Create new manifests by copying `bucket/app-name.json.template` to - `bucket/.json`. -7. Commit and push changes. -8. If you'd like your bucket to be indexed on `https://scoop.sh`, add the - topic `scoop-bucket` to your repository. - -## How do I install these manifests? - -After manifests have been committed and pushed, run the following: +After scoop has been installed, run the following: ```pwsh -scoop bucket add https://github.com// -scoop install / +scoop bucket add plutotree https://github.com/plutotree/scoop-bucket +scoop install plutotree/ ``` -## How do I contribute new manifests? +## Manifests + +| Name | Desc | Autoupdate | +| ------------- | ----------------------- | ---------- | +| bookxnote-pro | BookXNote Pro电子书阅读 | 🛠 | +| cos-browser | 腾讯云Cos管理工具 | ️️✔️️ | +| snipaste2 | Snipaste 截图 | 🛠 | -To make a new manifest contribution, please read the [Contributing -Guide](https://github.com/ScoopInstaller/.github/blob/main/.github/CONTRIBUTING.md) -and [App Manifests](https://github.com/ScoopInstaller/Scoop/wiki/App-Manifests) -wiki page. +- ✔️ Yes +- ❌ No +- 🛠 Additional testing is needed +- ✋ +- ⭕️ +- ⛔️