-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,28 @@ | ||
# Go Agent for the Internet Computer | ||
|
||
[![Go Version](https://img.shields.io/github/go-mod/go-version/aviate-labs/agent-go.svg)](https://github.com/aviate-labs/agent-go) | ||
[![GoDoc Reference](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/aviate-labs/agent-go) | ||
|
||
## Testing | ||
|
||
There are two types of tests within this repository; the normal go tests and [DFX](https://github.com/dfinity/sdk) dependent tests. The test suite will run a local replica through DFX to run some e2e tests. If you do not have it installed then those tests will be ignored. | ||
|
||
```shell | ||
go test -v ./... | ||
``` | ||
|
||
## Packages | ||
|
||
| Package Name | Links | Description | | ||
|---|---|---| | ||
| `agent` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/aviate-labs/agent-go) [![DOC](https://img.shields.io/badge/-DOC-blue)](https://pkg.go.dev/github.com/aviate-labs/agent-go) | A library to talk directly to the Replica. | | ||
| `identity` | [![DOC](https://img.shields.io/badge/-DOC-blue)](https://pkg.go.dev/github.com/aviate-labs/agent-go/identity) | A library that creates/manages identities. | | ||
|
||
### Dependencies | ||
|
||
| Package Name | Links | Description | | ||
|---|---|---| | ||
| `candid` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/aviate-labs/candid-go) [![DOC](https://img.shields.io/badge/-DOC-blue)](https://pkg.go.dev/github.com/aviate-labs/candid-go) | A Candid library for Golang | | ||
| `principal` | [![README](https://img.shields.io/badge/-README-green)](https://github.com/aviate-labs/principal-go) [![DOC](https://img.shields.io/badge/-DOC-blue)](https://pkg.go.dev/github.com/aviate-labs/principal-go) | Generic Identifiers for the Internet Computer | | ||
|
||
More dependencies in the [go.mod](./go.mod) file. |