Skip to content
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.

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

Updating SDK Documentation #52

Merged
merged 1 commit into from
Mar 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Updating SDK Documentation
  • Loading branch information
madflojo committed Mar 22, 2023
commit 8828de8330b8025d18e0033502f3e3bda9b28a20
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 4,7 @@

Write, Deploy and Scale Microservices with WebAssembly Functions

[![PkgGoDev](https://pkg.go.dev/badge/github.com/madflojo/tarmac)](https://pkg.go.dev/github.com/madflojo/tarmac)
[![PkgGoDev](https://pkg.go.dev/badge/github.com/madflojo/tarmac/pkg/sdk)](https://pkg.go.dev/github.com/madflojo/tarmac/pkg/sdk)
[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://tarmac.gitbook.io/tarmac/)
[![Build Status](https://github.com/madflojo/tarmac/actions/workflows/build.yml/badge.svg)](https://github.com/madflojo/tarmac/actions/workflows/build.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/madflojo/tarmac)](https://goreportcard.com/report/github.com/madflojo/tarmac)
Expand Down
2 changes: 1 addition & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 33,7 @@

## WebAssembly Developer Resources

* [Go SDK](https://pkg.go.dev/github.com/madflojo/tarmac@v0.4.0/pkg/sdk)
* [Go SDK](https://pkg.go.dev/github.com/madflojo/tarmac/pkg/sdk)
* [Toolkit](developers/toolkit.md)
* [GitHub](https://github.com/madflojo/tarmac)

2 changes: 1 addition & 1 deletion pkg/sdk/function/function.go
Original file line number Diff line number Diff line change
@@ -1,7 1,7 @@
/*
Package function is a client package for WASM functions running within a Tarmac server.

This package provides user-friendly function to call other WASM functions.
This package provides a user-friendly interface for interacting with other WASM functions. Users can use this package to call other loaded WASM functions. This capability enables users to create and call functions as if they are internal only.
*/
package function

Expand Down
5 changes: 5 additions & 0 deletions pkg/sdk/http/http.go
Original file line number Diff line number Diff line change
@@ -1,3 1,8 @@
/*
Package http is a client package for WASM functions running within a Tarmac server.

This package provides user-friendly HTTP client functions that can interact with external HTTP services. Guest WASM functions running inside Tarmac can import and call this HTTP client.
*/
package http

import (
Expand Down
5 changes: 5 additions & 0 deletions pkg/sdk/kvstore/kvstore.go
Original file line number Diff line number Diff line change
@@ -1,3 1,8 @@
/*
Package kvstore is a client package for WASM functions running within a Tarmac server.

This package provides a user-friendly Key:Value datastore interface that interacts with underlying datastores configured within Tarmac. Guest WASM functions running inside Tarmac can import and call this KV interface.
*/
package kvstore

import (
Expand Down
5 changes: 5 additions & 0 deletions pkg/sdk/metrics/metrics.go
Original file line number Diff line number Diff line change
@@ -1,3 1,8 @@
/*
Package metrics is a client package for WASM functions running within a Tarmac server.

This package provides user-friendly Metrics functions that enable users to create custom metrics. Guest WASM functions running inside Tarmac can import and call this Metrics interface.
*/
package metrics

import "fmt"
Expand Down
5 changes: 5 additions & 0 deletions pkg/sdk/sql/sql.go
Original file line number Diff line number Diff line change
@@ -1,3 1,8 @@
/*
Package sql is a client package for WASM functions running within a Tarmac server.

This package provides a user-friendly SQL database interface with underlying databases configured within Tarmac. Guest WASM functions running inside Tarmac can import and call this SQL interface.
*/
package sql

import (
Expand Down