8000 chore(docs): minor refinements on the README by madflojo · Pull Request #115 · tarmac-project/tarmac · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

chore(docs): minor refinements on the README #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 26, 2024
Merged

chore(docs): minor refinements on the README #115

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e86e5d5
chore(docs): minor refinements on the README
madflojo May 26, 2024
5f43787
Merge remote-tracking branch 'upstream/main' into minor-docs
madflojo May 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions docs/README.md
View file
Open in desktop
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
Loading
0