Skip to content

Commit

Permalink
Merge pull request #115 from madflojo/minor-docs
Browse files Browse the repository at this point in the history 
chore(docs): minor refinements on the README
  • Loading branch information
@madflojo
madflojo authored May 26, 2024
2 parents 136e15b + 5f43787 commit 220892d
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,9 +160,11 @@ By leveraging waPC, WebAssembly Functions can interact with Tarmac's core capabi

To provide a streamlined developer experience, Tarmac offers a Go SDK that simplifies the usage of waPC. The SDK abstracts away the complexity of using waPC, allowing developers to focus on writing their functions and leveraging Tarmac's features.

### Example Application - Architecture Diagram
### Example Application Architecture

The below diagram shows the architecture of the [Example Airport Lookup Application](https://github.com/tarmac-project/example-airport-lookup-go/tree/main). This application demonstrates how to build a multi-function service with Tarmac using Go.
The below diagram shows the architecture of an [example application](https://github.com/tarmac-project/example-airport-lookup-go/tree/main). This application demonstrates how to build a multi-function service with Tarmac using Go.

This example application will execute WebAssembly functions on boot and via a scheduler to manage airport data. The application also includes an HTTP server that serves the airport data to clients via a WebAssembly function.

```text
+-------------------------------------------------------------------------------------------------------+
Expand All @@ -179,7 +181,7 @@ The below diagram shows the architecture of the [Example Airport Lookup Applicat
| +--------------------------+ | +--+---------------------------------------------------+ | |
| | | | |
| | +--v-----------------------------+ | | +-----------------------------+
| | | Fetch: Download AirportData.CSV+------------------------+--+-->HTTP Server: AirportData.CSV |
| | | Fetch: Download AirportData.csv+------------------------+--+-->HTTP Server: AirportData.csv |
| | +--------------------------------+ | | +-----------------------------+
| | | |
+------+ | +--------------------+ | +----------------------------------+ | |
Expand Down

0 comments on commit 220892d

Please sign in to comment.