node-consul-service 1.0.9 → 1.0.11

package/README.md

@@ -5,87 +5,66 @@ A Node.js service that integrates with HashiCorp Consul for service discovery an
 ### Features
 - Service registration and discovery
 - Health checking
-- Key-value store integration
-- Configuration management
-- Distributed locking
-- Leader election
+- Service communication
+- Service instance management
 
 ### Prerequisites
 - Node.js (v14 or higher)
 - Consul server
-- npm or yarn
+- npm
 
 ### Installation
 ```bash
-# Clone the repository
-git clone https://github.com/your-username/node-consul-service.git
-
-# Navigate to project directory
-cd node-consul-service
-
-# Install dependencies
-npm install
+npm install node-consul-service
 ```
 
 ### Configuration
-Create a `.env` file in the root directory with the following variables:
+Create a `.env` file in your project root with the following variables:
 ```env
-CONSUL_HOST=localhost
+CONSUL_HOST=your-consul-host
 CONSUL_PORT=8500
-SERVICE_NAME=my-service
-SERVICE_PORT=3000
-```
-
-### Usage
-```bash
-# Start the service
-npm start
-
-# Run tests
-npm test
+CONSUL_SECURE=false
 ```
 
 ### Function Usage
 Here are the main functions available in the service:
 
 ```javascript
-// Service Registration
-const service = new ConsulService({
-  name: 'my-service',
-  port: 3000
+const { 
+  registerService,
+  callService,
+  listServices,
+  getServiceInstances,
+  getRandomServiceInstance
+} = require('node-consul-service');
+
+// Register a new service
+await registerService({
+  name: 'service-name',
+  id: 'service-id',
+  port: 3000,
+  address: 'localhost',
+  check: {
+    name: 'service health check',
+    http: 'http://localhost:3000/health',
+    interval: '10s',
+    timeout: '5s',
+    deregistercriticalserviceafter: '1m'
+  }
 });
-await service.register();
-
-// Service Discovery
-const services = await service.discover('service-name');
 
-// Key-Value Operations
-await service.setKey('config/key', 'value');
-const value = await service.getKey('config/key');
+// Call another service
+const result = await callService('service-name', '/endpoint');
 
-// Health Check
-await service.checkHealth();
+// List all registered services
+const services = await listServices();
 
-// Distributed Lock
-const lock = await service.acquireLock('resource-name');
-if (lock) {
-  // Perform locked operations
-  await service.releaseLock('resource-name');
-}
+// Get all instances of a specific service
+const instances = await getServiceInstances('service-name');
 
-// Leader Election
-await service.startLeaderElection('election-key');
-service.on('leader', () => {
-  // Handle leader election
-});
+// Get a random instance of a service
+const instance = await getRandomServiceInstance('service-name');
 ```
 
-### Contributing
-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.9",
+  "version": "1.0.11",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",
   "types": "dist/index.d.ts",