From 17970c6b783b13eb2b52c0258c9df493f51ae0a1 Mon Sep 17 00:00:00 2001
From: Nipuna Ranasinghe <nipunaranasinghe93@gmail.com>
Date: Mon, 25 Nov 2024 16:37:05 +0530
Subject: [PATCH] Make README.md as the default package documentation

---
 ballerina/Package.md               | 46 ------------------------------
 ballerina/{Module.md => README.md} |  0
 2 files changed, 46 deletions(-)
 delete mode 100644 ballerina/Package.md
 rename ballerina/{Module.md => README.md} (100%)

diff --git a/ballerina/Package.md b/ballerina/Package.md
deleted file mode 100644
index 5d5c746..0000000
--- a/ballerina/Package.md
+++ /dev/null
@@ -1,46 +0,0 @@
-## Package overview
-
-Avro is an open-source data serialization system that enables efficient binary serialization and deserialization. It allows users to define schemas for structured data, providing better representation and fast serialization/deserialization. Avro's schema evolution capabilities ensure compatibility and flexibility in evolving data systems.
-
-The Ballerina Avro module provides the capability to efficiently serialize and deserialize data using Avro schemas.
-
-## Schema
-
-The `Schema` instance accepts an Avro schema in `string` format. If the provided schema is not valid according to Avro, an error is returned. The client can be used to serialize data into bytes using the defined schema and deserialize the bytes back to the correct data type based on the schema.
-
-A `Schema` can be defined using the `string` value of an Avro schema as shown below.
-
-```ballerina
-avro:Schema schema = check new(string `{"type": "int", "namespace": "example.data" }`);
-```
-
-### APIs associated with Avro
-
-- **toAvro**: Serializes the given data according to the Avro format.
-- **fromAvro**: Deserializes the given Avro encoded message to the given data type.
-
-#### `toAvro`
-
-Serializes the given data according to the Avro format.
-
-```ballerina
-import ballerina/avro;
-
-public function main() returns error? {
-    int value = 5;
-    byte[] serializedData = check schema.toAvro(value);
-}
-```
-
-#### `fromAvro`
-
-Deserializes the given Avro encoded message to the given data type.
-
-```ballerina
-import ballerina/avro;
-
-public function main() returns error? {
-    byte[] data = // Avro encoded message ;
-    int deserializedData = check schema.fromAvro(data);
-}
-```
diff --git a/ballerina/Module.md b/ballerina/README.md
similarity index 100%
rename from ballerina/Module.md
rename to ballerina/README.md