From 8c1cb4059b907bdff0e7f2de162b6155cd593f57 Mon Sep 17 00:00:00 2001
From: Arto Bendiken <arto@asimov.so>
Date: Wed, 16 Oct 2024 12:33:31 +0400
Subject: [PATCH] Update the README.

---
 README.md | 55 ++++++++++++++++++++++++-------------------------------
 1 file changed, 24 insertions(+), 31 deletions(-)

diff --git a/README.md b/README.md
index a53d3d7..88c09b6 100644
--- a/README.md
+++ b/README.md
@@ -1,42 +1,35 @@
-# Scoop Bucket Template
+# Scoop Bucket for ASIMOV Platform
 
-<!-- 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) -->
+[![Tests](https://github.com/AsimovPlatform/scoop-bucket/actions/workflows/ci.yml/badge.svg)](https://github.com/AsimovPlatform/scoop-bucket/actions/workflows/ci.yml)
+[![Excavator](https://github.com/AsimovPlatform/scoop-bucket/actions/workflows/excavator.yml/badge.svg)](https://github.com/AsimovPlatform/scoop-bucket/actions/workflows/excavator.yml)
 
-Template bucket for [Scoop](https://scoop.sh), the Windows command-line installer.
+This repository contains public [Scoop] manifests for the [ASIMOV Platform].
 
-## How do I use this template?
+## Prerequisites
 
-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.
+- [Scoop], the Windows command-line installer
 
-## How do I install these manifests?
+## Configuration
 
-After manifests have been committed and pushed, run the following:
+Firstly, register this bucket in your local Scoop installation with:
 
 ```pwsh
-scoop bucket add <bucketname> https://github.com/<username>/<bucketname>
-scoop install <bucketname>/<manifestname>
+scoop bucket add AsimovPlatform https://github.com/AsimovPlatform/scoop-bucket
 ```
 
-## How do I contribute new manifests?
+## Installation
 
-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.
+### Install [Protoflow]
+
+```pwsh
+scoop install AsimovPlatform/protoflow
+```
+
+## Troubleshooting
+
+See [Scoop's documentation](https://github.com/ScoopInstaller/Scoop/wiki) in
+case of any trouble.
+
+[ASIMOV Platform]: https://github.com/AsimovPlatform
+[Protoflow]:       https://github.com/AsimovPlatform/protoflow
+[Scoop]:           https://scoop.sh