node-consul-service 1.0.19 → 1.0.20

package/README.md

@@ -1,44 +1,60 @@
 # Node Consul Service
 
-A Node.js service that integrates with HashiCorp Consul for service discovery and configuration management. This service provides a robust solution for managing distributed systems and microservices architecture.
-
-### Features
-- Service registration and discovery
-- Health checking
-- Service communication
-- Service instance management
-
-### Prerequisites
+A robust Node.js service that integrates with HashiCorp Consul for service discovery and configuration management. This service provides a comprehensive solution for managing distributed systems and microservices architecture, making it easier to handle service communication, health checks, and configuration management in a distributed environment.
+
+## Table of Contents
+- [Features](#features)
+- [Prerequisites](#prerequisites)
+- [Installation](#installation)
+- [Configuration](#configuration)
+- [API Documentation](#api-documentation)
+- [Examples](#examples)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Features
+- **Service Registration & Discovery**: Automatically register and discover services in your distributed system
+- **Health Checking**: Built-in health check mechanisms for service monitoring
+- **Service Communication**: Simplified inter-service communication with automatic load balancing
+- **Service Instance Management**: Easy management of multiple service instances
+- **Data Linking**: Efficient data aggregation and linking across services
+- **Caching Support**: Optional caching mechanism for improved performance
+
+## Prerequisites
 - Node.js (v14 or higher)
-- Consul server
-- npm
+- HashiCorp Consul server
+- npm or yarn package manager
+
+## Installation
 
-### Installation
 ```bash
+# Using npm
 npm install node-consul-service
+
+# Using yarn
+yarn add node-consul-service
 ```
 
-### Configuration
+## Configuration
+
 Create a `.env` file in your project root with the following variables:
+
 ```env
 CONSUL_HOST=your-consul-host
 CONSUL_PORT=8500
 CONSUL_SECURE=false
+CONSUL_TOKEN=your-consul-token  # Optional
+CONSUL_DC=your-datacenter      # Optional
 ```
 
-### Function Usage
-Here are the main functions available in the service:
+## API Documentation
 
+### Core Functions
+
+#### Service Registration
 ```javascript
-const { 
-  registerService,
-  callService,
-  listServices,
-  getServiceInstances,
-  getRandomServiceInstance
-} = require('node-consul-service');
+const { registerService } = require('node-consul-service');
 
-// Register a new service
 await registerService({
   name: 'service-name',
   id: 'service-id',
@@ -52,10 +68,31 @@ await registerService({
     deregistercriticalserviceafter: '1m'
   }
 });
+```
 
-// Call another service
+#### Service Communication
+```javascript
+const { callService } = require('node-consul-service');
+
+// Simple GET request
 const result = await callService('service-name', '/endpoint');
 
+// POST request with data
+const response = await callService('service-name', {
+  method: 'POST',
+  path: '/endpoint',
+  data: { key: 'value' }
+});
+```
+
+#### Service Discovery
+```javascript
+const { 
+  listServices,
+  getServiceInstances,
+  getRandomServiceInstance 
+} = require('node-consul-service');
+
 // List all registered services
 const services = await listServices();
 
@@ -64,14 +101,15 @@ const instances = await getServiceInstances('service-name');
 
 // Get a random instance of a service
 const instance = await getRandomServiceInstance('service-name');
+```
+
+### Data Linking
 
-### dataLink Function
-This function is used to link data from different services. It aggregates data from multiple sources and links them based on common identifiers.
+The `dataLink` function provides a powerful way to aggregate and link data from multiple services efficiently.
 
 ```javascript
 const { dataLink } = require('node-consul-service');
 
-// Example of using dataLink
 const data = [
   { userId: '123', name: 'John' },
   { userId: '456', name: 'Jane' }
@@ -98,5 +136,64 @@ const result = await dataLink(data, schema);
 - `path`: API endpoint path in the target service
 - `cacheGetter`: Optional function to get data from cache before calling the service
 
-### License
+## Examples
+
+### Basic Service Setup
+```javascript
+const { registerService, callService } = require('node-consul-service');
+
+// Register your service
+await registerService({
+  name: 'my-service',
+  id: 'my-service-1',
+  port: 3000,
+  address: 'localhost',
+  check: {
+    http: 'http://localhost:3000/health',
+    interval: '10s'
+  }
+});
+
+// Call another service
+const response = await callService('other-service', '/api/data');
+```
+
+### Advanced Data Linking
+```javascript
+const { dataLink } = require('node-consul-service');
+
+// Complex data linking example
+const orders = [
+  { orderId: '1', userId: '123', productId: 'P1' },
+  { orderId: '2', userId: '456', productId: 'P2' }
+];
+
+const schema = [
+  {
+    filed: 'userId',
+    service: 'user-service',
+    path: '/api/users/batch'
+  },
+  {
+    filed: 'productId',
+    service: 'product-service',
+    path: '/api/products/batch'
+  }
+];
+
+const enrichedOrders = await dataLink(orders, schema);
+```
+
+## Contributing
+
+We welcome contributions! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+## License
+
 This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-consul-service",
-  "version": "1.0.19",
+  "version": "1.0.20",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",