Skip to content

Commit

Permalink
chore: v1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex-Werner committed Dec 16, 2023
1 parent 05d4b3c commit 4b45e23
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 8 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
# askr
# node-askr

[![npm version](https://badge.fury.io/js/node-askr.svg)](https://badge.fury.io/js/node-askr)

Stupid Simple Microservices dispatcher

## Description

Askr is a simple protocol that helps you to build a network of microservices that can communicate with each other.
Node Askr is a simple protocol that helps you to build a network of microservices that can communicate with each other.
It also allows a Client to pass along command, listen or emit message so that the microservices can react to it.


Expand Down Expand Up @@ -41,7 +44,7 @@ Client will ask for time, then start, wait 5s and stop the server.
`server.js` - Simulate an microservice agent that would fetch and emit info to a system.

```js
import {Askr} from 'askr';
import {Askr} from 'node-askr';

const agentNode = new Askr({
name: 'agent'
Expand Down Expand Up @@ -89,7 +92,7 @@ agentNode.on('fetch', async (event, peer) => {
`client.js` - Simulate a client that would listen to the agent's event and react to it (send commands).

```js
import { Client } from 'askr';
import { Client } from 'node-askr';

(async () => {
const client = new Client({
Expand Down
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "askr",
"name": "node-askr",
"version": "1.0.0",
"description": "Stupid Simple Microservices dispatcher",
"main": "index.js",
Expand All @@ -10,14 +10,14 @@
"type": "module",
"repository": {
"type": "git",
"url": "git+https://github.com/Alex-Werner/askr.git"
"url": "git+https://github.com/Alex-Werner/node-askr.git"
},
"author": "Alex Werner <@obusco>",
"license": "MIT",
"bugs": {
"url": "https://github.com/Alex-Werner/askr/issues"
"url": "https://github.com/Alex-Werner/node-askr/issues"
},
"homepage": "https://github.com/Alex-Werner/askr#readme",
"homepage": "https://github.com/Alex-Werner/node-askr#readme",
"dependencies": {
"hermodlog": "^1.0.0"
},
Expand Down

0 comments on commit 4b45e23

Please sign in to comment.