Skip to content

Commit ff713a1

Browse files
committed
Merge upstream
2 parents 3c00ddb + c4278b7 commit ff713a1

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

src/templates/.README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ Ever wish you could show npm, gem, mvn, Gradle, NuGet, or GHCR badges for GitHub
2121
If this is [`ipitio/backage`](https://github.com/ipitio/backage), all you have to do is **star the repo to get your public packages added!** The service's circular priority queue will update the [closed-loop system](https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/releases/latest) with them within the next few hours. Additionally watching and forking the repo, and following the owner, are ways to increase their priority. Yes, I know, but these are the graphs GitHub has available.
2222

2323
> [!WARNING]
24-
> For this to work, your profile must be set to [public](https://github.com/ipitio/backage/issues/34#issuecomment-2968850773).
24+
> Ensure your profile is [public](https://github.com/ipitio/backage/issues/34#issuecomment-2968850773) so that this repo can see your packages.
2525
26-
Otherwise, if this is a fork, you'd prefer an alternative method, or your packages weren't added to the [index](https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/tree/index) after a day, enter the case-sensitive name of each missing user or organization on a new line at the top of `owners.txt` [here](https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/edit/master/owners.txt) and make a pull request. Don't worry -- while my Contribution Graph is an uptime monitor of sorts, yours won't be. See the top of `bkg.sh` for details about available options, which must come last when passed to `update.sh`, as shown in `Self-Host`.
26+
Otherwise, if this is a fork, you'd prefer an alternative method, or your packages weren't added to the [index](https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/tree/index) after a day, enter the case-sensitive name of each missing user or organization on a new line at the top of the queue, `owners.txt`, [here](https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/edit/master/owners.txt) and make a pull request. Don't worry -- while my Contribution Graph is an uptime monitor of sorts, yours won't be. See the top of `bkg.sh` for details about available options, which must come last when passed to `update.sh`, as shown in `Self-Host` below.
2727

2828
> [!TIP]
29-
> You only need to add the name(s), IDs are fetched as needed.
29+
> You only need to add names to the queue; IDs are fetched as needed and entries are removed once processed.
3030
3131
New packages won't be added until *all* existing ones are refreshed; you should also create an independent instance that'll update faster and more frequently. Simply fork just the `master` branch, choose one of the following options, and use the [Alternative URL](#alternative-url) when it changes. This centralized repo will then serve as a backup for all subsets of packages not in `optout.txt`.
3232

@@ -49,10 +49,10 @@ This will use a lot of minutes on GitHub-hosted runners, so you may want to use
4949
This is an example for `systemd`; adapt it to your needs. Please note:
5050

5151
- Docker needs to be installed
52-
- You don't need to set `GITHUB_TOKEN` if you're logged in with `gh` or you'll first use your PAT to run (replace `*` with `https` or `ssh`):
52+
- You don't need to set `GITHUB_TOKEN` if you first log in with `gh` or use your PAT to run:
5353

5454
```bash
55-
git clone --depth=1 -b <GITHUB_BRANCH> --single-branch *://<PAT>@github.com/<GITHUB_OWNER>/<GITHUB_REPO> /opt/<GITHUB_REPO>/<GITHUB_BRANCH>
55+
git clone --depth=1 -b <GITHUB_BRANCH> --single-branch [https|ssh]://<PAT>@github.com/<GITHUB_OWNER>/<GITHUB_REPO> /opt/<GITHUB_REPO>/<GITHUB_BRANCH>
5656
```
5757

5858
- `-m 0` ensures only the public packages of the owners you've added are updated (default)
@@ -205,27 +205,27 @@ $.[FILTER].PROPERTY
205205
You can query a package for its properties, like size or version:
206206
207207
```py
208-
/xml/PROPERTY
208+
//PROPERTY
209209
```
210210
211211
```py
212-
/xml/size
212+
//size
213213
```
214214
215215
Versions can be filtered in and tags out:
216216
217217
```py
218-
/xml/version[FILTER]/PROPERTY
218+
//version[FILTER]/PROPERTY
219219
```
220220
221221
```py
222-
/xml/version[./latest[.="true"]]/tags[.!="latest"]
222+
//version[./latest[.="true"]]/tags[.!="latest"]
223223
```
224224
225225
As can packages in `owner[/repo]/.xml` files:
226226
227227
```py
228-
/xml/package[FILTER]/PROPERTY
228+
//package[FILTER]/PROPERTY
229229
```
230230
231231
</details>
@@ -238,12 +238,12 @@ https://github.com/<GITHUB_OWNER>/<GITHUB_REPO>/raw/index/OWNER/[REPO/[PACKAGE]]
238238
239239
The endpoint is also available here! This will change to your fork once it updates.
240240
241-
## JSON2XML Proxy
241+
## Bring Your Own JSON
242242
243243
```py
244244
https://ipitio.github.io/backage?json=https://URL/ENCODED/JSON
245245
```
246246

247-
Use your own external JSON with this proxy to convert it into XML. This doesn't currently work with Shields. Try it out in your browser:
247+
While this doesn't directly work with Shields, you can BYOJ to convert into XML. Try it out in your browser:
248248

249249
**<https://ipitio.github.io/backage?json=https://raw.githubusercontent.com/<GITHUB_OWNER>/<GITHUB_REPO>/index/.json>**

0 commit comments

Comments
 (0)