Skip to content

Commit

Permalink
Merge pull request #4 from benzlokzik/feature/readme-usage-full-guide
Browse files Browse the repository at this point in the history
added guide for endpoints
  • Loading branch information
benzlokzik committed Nov 6, 2023
2 parents c65aa7c + 4be66be commit 05dd7cf
Showing 1 changed file with 38 additions and 1 deletion.
39 changes: 38 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@

Simple http Fahrenheit/Celsius/Kelvin converter using [actix-web](https://actix.rs/).


---

> [!NOTE]\
Expand All @@ -28,3 +27,41 @@ Via Docker:
docker build -t fahrenheit-celsius-converter .
docker run -p 8080:8080 fahrenheit-celsius-converter
```

## API

### Convert Fahrenheit to Celsius

```bash
curl -X GET "http://localhost:8080/convert/f_to_c/100"
```

### Convert Celsius to Fahrenheit

```bash
curl -X GET "http://localhost:8080/convert/c_to_f/100"
```

### Convert Fahrenheit to Kelvin

```bash
curl -X GET "http://localhost:8080/convert/f_to_k/100"
```

### Convert Kelvin to Fahrenheit

```bash
curl -X GET "http://localhost:8080/convert/k_to_f/100"
```

### Convert Celsius to Kelvin

```bash
curl -X GET "http://localhost:8080/convert/c_to_k/100"
```

### Convert Kelvin to Celsius

```bash
curl -X GET "http://localhost:8080/convert/k_to_c/100"
```

0 comments on commit 05dd7cf

Please sign in to comment.