Skip to content

Commit

Permalink
readme formatting updated (#135)
Browse files Browse the repository at this point in the history
  • Loading branch information
petracihalova authored Jul 19, 2023
1 parent d0972eb commit e78371b
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,12 @@ export ENT_SUBS_HOST=https://subscription.dev.api.redhat.com
export ENT_COMPLIANCE_HOST=https://export-compliance.dev.api.redhat.com
```

Replace {path_to_key} and {path_to_cert} with the locations of the .key and .crt files from the previous section.
Replace `{path_to_key}` and `{path_to_cert}` with the locations of the `.key` and `.crt` files from the previous section.

### Set up your local entitlement bundles

Copy the `/bundles/bundles.example.yml` to `/bundles/bundles.yml` in order to have your local app consume bundle data. You can modify this file for local testing.

**Note:** _This file is for local testing only. If you wish to make changes to the actual bundles, please refer to https://github.com/RedHatInsights/entitlements-config_

## Running the Application
Expand All @@ -82,7 +83,7 @@ docker run -p 3000:3000 entitlements-api-go

## Testing Entitlements API with curl

The Entitlements API requires that you pass in a valid x-redhat-identity header or it rejects requests.
The Entitlements API requires that you pass in a valid `x-redhat-identity` header or it rejects requests.
For an example see `cat ./scripts/xrhid_helper.sh`

## Testing the bundle-sync
Expand All @@ -98,6 +99,6 @@ go build -o ./bundle-sync bundle_sync/main.go
## Running the Unit Tests

* To run the unit tests, execute the following commands from the terminal:
make test
`make test`
* To include benchmarks:
make bench
`make bench`

0 comments on commit e78371b

Please sign in to comment.