Skip to content

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
tonghuang committed Jan 16, 2024
1 parent 1ab53bf commit f1c8a9c
Showing 1 changed file with 18 additions and 35 deletions.
53 changes: 18 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

<!-- Uncomment the following line after replacing placeholders -->
<!-- [![Tests](https://github.com/<username>/<bucketname>/actions/workflows/ci.yml/badge.svg)](https://github.com/<username>/<bucketname>/actions/workflows/ci.yml) [![Excavator](https://github.com/<username>/<bucketname>/actions/workflows/excavator.yml/badge.svg)](https://github.com/<username>/<bucketname>/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/<app-name>.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 <bucketname> https://github.com/<username>/<bucketname>
scoop install <bucketname>/<manifestname>
scoop bucket add plutotree https://github.com/plutotree/scoop-bucket
scoop install plutotree/<manifestname>
```

## 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
-
- ⭕️
- ⛔️

0 comments on commit f1c8a9c

Please sign in to comment.