diff --git a/.env_sample b/.env_sample index b641093..01d3fc8 100644 --- a/.env_sample +++ b/.env_sample @@ -1,3 +1,4 @@ export FTEST_AUTH="foobar" +export FTEST_HOST="http://ftest.example.org" export FTEST_TARGET_HOST="http://localhost:3000" export FTEST_USER="john@example.org" diff --git a/README.md b/README.md index 2f39872..55a0fd0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +[![status-badge](https://ci.batsense.net/api/badges/86/status.svg)](https://ci.batsense.net/repos/86) + +--- + # WebFinger tests for ForgeFlux/ftest ## TODO @@ -10,11 +14,12 @@ Please see [`.env_sample`](./.env_sample) -| NAME | Purpose | Example | -| ------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- | -| `FTEST_AUTH` | Authorization token for uploading test results to ftest server | a random-generated string that will be provided by ftest server | -| `FTEST_TARGET_HOST` | The URL of the implementation's instance against which tests will be run | `http://localhost:3000`, if Forgejo or any other WebFinger implementation is running on localhost at port 3000 | -| `FTEST_USER` | address of the actor against which WebFinger tests will be run | `john@localhost:3000`. User `john` should exist on the instance | +| NAME | Purpose | Example | +| ------------------- | ------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | +| `FTEST_AUTH` | Authorization token for uploading test results to ftest server | a random-generated string that will be provided by ftest server | +| `FTEST_HOST` | The URL of the ftest's instance to which tests results should be uploaded | `http://localhost:5000`, if an ftest implementation is running on localhost at port 5000 | +| `FTEST_TARGET_HOST` | The URL of the implementation's instance against which tests will be run | `http://localhost:3000`, if Forgejo or any other WebFinger implementation is running on localhost at port 3000 | +| `FTEST_USER` | address of the actor against which WebFinger tests will be run | `john@localhost:3000`. User `john` should exist on the instance | ## Usage