diff --git a/README.md b/README.md index b9b53b85ab1a0f66575ffd34b86d764bc838da62..b7832e5e3d096e351d2debdf968f0dc87c7ecedc 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,38 @@ ```bash go install github.com/mitjafelicijan/hepi@latest ``` +## Basic example + +```yaml +environments: + local: + host: http://localhost:8080 + +requests: + login: + method: POST + url: "{{host}}/v1/auth/login" + description: "Authenticate and get a token" + headers: + Content-Type: "application/json" + json: + username: "admin" + password: "secret-password" + + get_profile: + method: GET + url: "{{host}}/v1/profile" + description: "Fetch user profile using the token from login" + headers: + Authorization: "Bearer {{login.token}}" + Accept: "application/json" + +groups: + auth_flow: + - login + - get_profile +``` + ## CLI Usage ### Basic Usage