qrusty-client 0.1.0

package/README.md

@@ -0,0 +1,69 @@
+# qrusty-client
+
+Node.js client for the qrusty priority queue server API.
+
+## Features
+
+- Connect to a qrusty server
+- Publish, consume, ack, and purge messages
+- List and manage queues
+- Promise-based API using axios
+
+## Installation
+
+```bash
+npm install qrusty-client
+```
+
+## Usage
+
+```js
+const QrustyClient = require('qrusty-client');
+const client = new QrustyClient('http://localhost:3000');
+
+(async () => {
+  await client.publish('orders', 100, { order_id: 123 });
+  const msg = await client.consume('orders', 'worker-1');
+  await client.ack('orders', msg.id, 'worker-1');
+})();
+```
+
+## Documentation
+
+Generate HTML docs with:
+
+```bash
+npm run docs
+```
+
+## Testing
+
+Run unit tests with:
+
+```bash
+npm test
+```
+
+## Publishing
+
+1. Log in to npm (if you haven't):
+
+   ```bash
+   npm login
+   ```
+
+2. Publish the package:
+
+   ```bash
+   npm publish
+   ```
+
+## Credentials Needed
+
+- You need an npm account (<https://www.npmjs.com/>)
+- Run `npm login` and enter your username, password, and email
+- This stores your credentials in `~/.npmrc` for publishing
+
+## License
+
+MIT