Merge pull request #2 from Azure/swapnil/SdkBlobBindingReadmeUpdate

Updating Readme and Linting issues

Author: swapnil-nagar

azure-functions-nodejs-extensions-base/README.md

@@ -1 +1,33 @@
-# To be created.
+# Azure Functions Node.js Extensions Base
+
+The Azure Functions Node.js Extensions Base Library provides core interfaces, classes, and utilities for building extension components for Azure Functions in JavaScript and TypeScript to recognize and bind to SDK types. **It is not intended for direct use**. Instead, please reference one of the extending packages:
+
+[@azure/functions-extensions-bindings-blob](https://github.com/Azure/azure-functions-nodejs-extensions/tree/main/azure-functions-nodejs-extensions-blob)
+
+## Features
+
+-   **Resource Factory Resolver**: Core singleton class for registering and retrieving Azure resource factories
+-   **Model Binding Support**: Types and interfaces for binding Azure resources to Function parameters
+-   **Type-Safe Bindings**: Type definitions for supported Azure binding types
+-   **Extension Registration**: Foundation for registering extensions in Azure Functions
+
+## Integration with Azure Functions
+
+This library serves as a foundation for Azure Functions extensions that provide additional bindings or integration capabilities. For examples of extensions built on this library, see:
+
+-   [@azure/functions-extensions-bindings-blob](https://github.com/Azure/azure-functions-nodejs-extensions/tree/main/azure-functions-nodejs-extensions-blob)
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](./LICENSE) file for details.
+
+## Resources
+
+-   [Azure Functions Documentation](https://learn.microsoft.com/azure/azure-functions/)
+-   [Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
+
+---
+
+## Reporting Issues
+
+If you find a bug or have a suggestion for improvement, please [open an issue](https://github.com/Azure/azure-functions-nodejs-extensions/issues) on our GitHub repository.

azure-functions-nodejs-extensions-blob/README.md

@@ -1 +1,103 @@
-# To be created.
+## Azure Functions Node.js Extensions - Blob
+
+This project provides extensions for working with Azure Blob Storage in Azure Functions using Node.js. It simplifies the integration and interaction with Blob Storage, enabling developers to build scalable and efficient serverless applications.
+
+### Features
+
+-   **Blob Trigger**: Automatically trigger Azure Functions when a blob is created or updated in a specified container.
+-   **Blob Input Binding**: Read blob content as input to your function.
+-   **Cached Client Management**: Optimized client reuse with intelligent caching
+-   **Resource Management**: Proper disposal patterns for Azure resource clients
+-   **Performance Optimizations**: Reduced overhead for blob operations
+
+### Prerequisites
+
+-   [Node.js](https://nodejs.org/) (LTS version recommended)
+-   [Azure Functions Core Tools](https://learn.microsoft.com/azure/azure-functions/functions-run-local)
+-   An active [Azure subscription](https://azure.microsoft.com/free/)
+
+### Installation
+
+To install the required dependencies, run:
+
+```bash
+npm install @azure/functions-extensions-blob
+```
+
+### Usage
+
+1. **Set up your Azure Blob Storage account**:
+
+    - Create a storage account in the Azure portal.
+    - Create a container within the storage account.
+
+2. **Configure your function**:
+
+    - Update the `function.json` file to include the appropriate bindings for Blob Storage.
+
+3. **Import and initialize the extension:**
+
+```javascript
+import '@azure/functions-extensions-blob'; // Ensures at the top of the file
+```
+
+Using in Azure Functions
+
+```javascript
+import "@azure/functions-extensions-blob"; // Ensures side effects run
+import { StorageBlobClient } from "@azure/functions-extensions-blob";
+import { app, InvocationContext } from "@azure/functions";
+
+export async function storageBlobTrigger1(
+  blobStorageClient: StorageBlobClient,
+  context: InvocationContext
+): Promise<void> {
+  context.log(
+    `Storage blob function processed blob "${context.triggerMetadata.name}"`
+  );
+  try {
+     // Use the cached client for better performance
+    const downloadBlockBlobResponse =
+      await blobStorageClient.blobClient.download();
+// Additional operations...
+
+  }
+}
+
+app.storageBlob("storageBlobTrigger1", {
+  path: "snippets/SomeFolder/{name}",
+  connection: "AzureWebJobsStorage",
+  sdkBinding: true, //Ensure this is set to true
+  handler: storageBlobTrigger1,
+});
+
+
+```
+
+4. **Run locally**:
+
+-   Use the Azure Functions Core Tools to run your function locally:
+    `bash
+     func start
+     `
+
+4. **Deploy to Azure**:
+
+-   Deploy your function to Azure using the following command:
+    `bash
+      func azure functionapp publish <YourFunctionAppName>
+      `
+
+### Contributing
+
+Contributions are welcome! Please follow the [contribution guidelines](CONTRIBUTING.md) when submitting issues or pull requests.
+
+### License
+
+This project is licensed under the [MIT License](LICENSE).
+
+### Resources
+
+-   [Azure Functions Documentation](https://learn.microsoft.com/azure/azure-functions/)
+-   [Azure Blob Storage Documentation](https://learn.microsoft.com/azure/storage/blobs/)
+-   [Azure SDK for JavaScript](https://learn.microsoft.com/azure/javascript/)