From ad5ff7ebd0a538e745f76b15f77b8677901c73a1 Mon Sep 17 00:00:00 2001 From: Marc-Aurele Besner <82244926+marc-aurele-besner@users.noreply.github.com> Date: Sat, 16 Nov 2024 07:17:13 -0500 Subject: [PATCH 1/3] unify readmes formatting --- packages/auto-dag-data/README.md | 2 +- packages/auto-drive/README.md | 28 +++++++++++++++++++++++++--- packages/auto-utils/README.md | 2 +- 3 files changed, 27 insertions(+), 5 deletions(-) diff --git a/packages/auto-dag-data/README.md b/packages/auto-dag-data/README.md index aca7d6e2..1d6b1e07 100644 --- a/packages/auto-dag-data/README.md +++ b/packages/auto-dag-data/README.md @@ -1,4 +1,4 @@ -# Auto DAG Data +# Autonomys Auto DAG Data SDK ![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp) diff --git a/packages/auto-drive/README.md b/packages/auto-drive/README.md index 7f97daad..d828e98d 100644 --- a/packages/auto-drive/README.md +++ b/packages/auto-drive/README.md @@ -1,8 +1,14 @@ -# auto-drive +# Autonomys Auto Drive SDK -## auto-drive API Tools +![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp) -The `auto-drive` package provides a set of tools to interact with the auto-drive API. Below are some key functionalities: +[![Latest Github release](https://img.shields.io/github/v/tag/autonomys/auto-sdk.svg)](https://github.com/autonomys/auto-sdk/tags) +[![Build status of the main branch on Linux/OSX](https://img.shields.io/github/actions/workflow/status/autonomys/auto-sdk/build.yaml?branch=main&label=Linux%2FOSX%20build)](https://github.com/autonomys/auto-sdk/actions/workflows/build.yaml) +[![npm version](https://badge.fury.io/js/@autonomys%2Fauto-drive.svg)](https://badge.fury.io/js/@autonomys/auto-drive) + +## Overview + +The `auto-drive` package provides a set of tools to interact with the Autonomys Auto-Drive API. Below are some key functionalities: ### Installation @@ -72,3 +78,19 @@ getRoots(api) console.error('Error retrieving root directories:', error) }) ``` + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. + +## Additional Resources + +- **Autonomys Academy**: Learn more at [Autonomys Academy](https://academy.autonomys.xyz). + +## Contact + +If you have any questions or need support, feel free to reach out: + +- **GitHub Issues**: [GitHub Issues Page](https://github.com/autonomys/auto-sdk/issues) + +We appreciate your feedback and contributions! diff --git a/packages/auto-utils/README.md b/packages/auto-utils/README.md index 3cc1a677..a44c6d01 100644 --- a/packages/auto-utils/README.md +++ b/packages/auto-utils/README.md @@ -1,4 +1,4 @@ -# Autonomys Auto SDK Utility +# Autonomys Auto Utility SDK ![Autonomys Banner](https://github.com/autonomys/auto-sdk/blob/main/.github/images/autonomys-banner.webp) From 521410b78cd2ed74a711eddde45d86529a5c0b5b Mon Sep 17 00:00:00 2001 From: Marc-Aurele Besner <82244926+marc-aurele-besner@users.noreply.github.com> Date: Sat, 16 Nov 2024 07:20:06 -0500 Subject: [PATCH 2/3] list Auto-Drive in root readme --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1ddc2587..75016b07 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,7 @@ This monorepo contains multiple packages, each serving a specific purpose. All p - **[`@autonomys/auto-consensus`](https://www.npmjs.com/package/@autonomys/auto-consensus)**: Functions for interacting with the Consensus Layer. - **[`@autonomys/auto-dag-data`](https://www.npmjs.com/package/@autonomys/auto-dag-data)**: Tools for preparing and managing data for on-chain storage. - **[`@autonomys/auto-id`](https://www.npmjs.com/package/@autonomys/auto-id)**: Functions for generating, renewing, and revoking Decentralized Identities (Auto IDs). +- **[`@autonomys/auto-drive`](https://www.npmjs.com/package/@autonomys/auto-drive)**: Tools for interacting with the Autonomys Auto-Drive API. ## Installation From 9ad5e68bb6600e2e18030116649aa0b449591338 Mon Sep 17 00:00:00 2001 From: Marc-Aurele Besner <82244926+marc-aurele-besner@users.noreply.github.com> Date: Sat, 16 Nov 2024 11:48:27 -0500 Subject: [PATCH 3/3] remove .md exception from workflow, since this workflow is mandatory --- .github/workflows/build.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml index 419ed051..0e0bef79 100644 --- a/.github/workflows/build.yaml +++ b/.github/workflows/build.yaml @@ -4,11 +4,7 @@ on: push: branches: - main - paths-ignore: - - '**.md' pull_request: - paths-ignore: - - '**.md' workflow_dispatch: jobs: