Merge pull request #172 from autonomys/chore/unify-readmes-formatting

Unify README's formatting

.github/workflows/build.yaml

@@ -4,11 +4,7 @@ on:
   push:
     branches:
       - main
-    paths-ignore:
-      - '**.md'
   pull_request:
-    paths-ignore:
-      - '**.md'
   workflow_dispatch:
 
 jobs:

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
 

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)
 

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!

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)