serokell/xrefcheck
1
1
Fork 0
mirror of https://github.com/serokell/xrefcheck.git synced 2024-10-03 17:07:53 +03:00
Code Issues Projects Releases Wiki Activity

[Chore] Incorporate Scarf (#281)

Browse Source 
Problem: we'd like to get some statistics about our users, so that
we know how many people use `xrefcheck` or at least view its README,
from what OS they do it, etc.

Solution:
There is a tool called [Scarf](https://about.scarf.sh/) that
can be used for this purpose.

1. Create a Docker package in Scarf which acts as a proxy,
so that instead of `docker pull serokell/xrefcheck` one will use
`docker pull serokell.docker.scarf.sh/serokell/xrefcheck` and
Scarf will automatically record some (anonymyzed) data.

2. Create a File package in Scarf which acts as another proxy.
It downloads artifacts from GitHub releases, e. g.:
https://serokell.gateway.scarf.sh/xrefcheck/v0.2.2/xrefcheck-x86_64-linux

3. Mention these links in usage instructions.

4. Add a tracking pixel to README to also get statistics about
README views.
This commit is contained in:
Ivan Gromakovskii 2023-07-06 18:34:05 +06:00 committed by GitHub
parent 7888853694
commit 64a338b567
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -7,6 +7,7 @@
# Xrefcheck
![Build status](https://github.com/serokell/xrefcheck/actions/workflows/ci.yml/badge.svg)
<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=bdf72cff-c1f1-4b3a-97f0-5083dbb77fa6" />
Xrefcheck is a tool for verifying local and external references in a repository's documentation that is quick, easy to setup, and suitable to be run on a CI pipeline.
@ -55,8 +56,17 @@ Xrefcheck requires you to have `git` version 2.18.0 or later in your PATH.
We provide the following ways for you to use xrefcheck:
- [GitHub Actions](https://github.com/marketplace/actions/xrefcheck)
- [Statically linked binaries](https://github.com/serokell/xrefcheck/releases)
- [Statically linked binaries](https://github.com/serokell/xrefcheck/releases), e. g. on Linux:
```
mkdir -p bin/
wget --quiet -O bin/xrefcheck https://serokell.gateway.scarf.sh/xrefcheck/latest/xrefcheck-x86_64-linux
chmod +x bin/xrefcheck
bin/xrefcheck
```
- [Docker image](https://hub.docker.com/r/serokell/xrefcheck)
```
docker pull serokell.docker.scarf.sh/serokell/xrefcheck
```
- [Building from source](#build-instructions-)
- Nix
```