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

docs: Enhance README.md for clarity and structure #179

Merged
merged 1 commit into from
Dec 10, 2024
Merged
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
35 changes: 18 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,32 @@
# Akash API

[![lint](https://github.com/akash-network/akash-api/actions/workflows/lint.yaml/badge.svg)](https://github.com/akash-network/akash-api/actions/workflows/lint.yaml)
[![tests](https://github.com/akash-network/akash-api/actions/workflows/tests.yaml/badge.svg)](https://github.com/akash-network/akash-api/actions/workflows/tests.yaml)
[![Lint Status](https://github.com/akash-network/akash-api/actions/workflows/lint.yaml/badge.svg)](https://github.com/akash-network/akash-api/actions/workflows/lint.yaml)
[![Test Status](https://github.com/akash-network/akash-api/actions/workflows/tests.yaml/badge.svg)](https://github.com/akash-network/akash-api/actions/workflows/tests.yaml)

## Brief
The purpose of this repo is to combine gRPC API definitions for [Akash node](https://github.com/akash-network/node)
and [Akash provider](https://github.com/akash-network/provider) in a single place as well as code-generation related to it.
## Overview

There are currently defined two buf packages with further intentions to be published into BSR if there is demand for it:
- `buf.build/akash-network/node` - Akash protobuf definitions previously located in [proto](https://github.com/akash-network/node/tree/master/proto/akash)
have all been moved [under](./proto/node/akash). All generated code can be found [here](./go/node)
- `buf.build/akash-network/provider` - Akash manifest definitions previously defined as plan Go structs have been converted into Protobuf [definitions](./proto/provider/akash)
This repository consolidates gRPC API definitions for the [Akash Node](https://github.com/akash-network/node) and [Akash Provider](https://github.com/akash-network/provider). It also includes related code generation.

Proto docs are available:
- for [node](docs/proto/node.md)
- for [provider](docs/proto/provider.md)
Currently, two `buf` packages are defined, with potential future publication to BSR based on demand:
- **Node Package**: `buf.build/akash-network/node`
- Akash protobuf definitions, previously located in the [proto directory](https://github.com/akash-network/node/tree/master/proto/akash), are now under [proto/node/akash](./proto/node/akash).
- Generated code is available [here](./go/node).
- **Provider Package**: `buf.build/akash-network/provider`
- Akash manifest definitions, previously defined as plain Go structs, have been converted into Protobuf [definitions](./proto/provider/akash).

Proto documentation is available for:
- [Node](docs/proto/node.md)
- [Provider](docs/proto/provider.md)

## Contributing

Issues should be submitted via [support repo](https://github.com/akash-network/support/issues) and tagged with `repo/akash-api`.
All PRs must have an open issue in the support repo.
Please submit issues via the [support repository](https://github.com/akash-network/support/issues) and tag them with `repo/akash-api`. All pull requests must be associated with an open issue in the support repository.

## Releases

Actual releases indicating changes to the repo itself. API version are defined withing each module.
Releases indicate changes to the repository itself. API versions are defined within each module.

## Pre-generated packages
## Pre-generated Packages

We provide generated code allowing developers to just import and focus on features, not how to generate stubs.
We provide generated code to allow developers to focus on features rather than stub generation:
- [Go](./go)
Loading