Skip to content

Commit

Permalink
feat: update README.md and add checks workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
eliassjogreen committed Jan 5, 2023
1 parent b4f3784 commit 505d3ce
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
open_collective: denosaurs
github: denosaurs
60 changes: 60 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: check

on: [push, pull_request]

jobs:
lint:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v2

- name: Setup latest deno version
uses: denoland/setup-deno@main
with:
deno-version: v1.x

- name: Run deno lint
run: deno lint --unstable

fmt:
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v2

- name: Setup latest deno version
uses: denoland/setup-deno@main
with:
deno-version: v1.x

- name: Run deno fmt
run: deno fmt --check

# test:
# runs-on: ubuntu-latest
# steps:
# - name: Checkout sources
# uses: actions/checkout@v2
#
# - name: Setup latest deno version
# uses: denoland/setup-deno@main
# with:
# deno-version: v1.x
#
# - name: Run deno test
# run: deno test --allow-all --unstable

# doc:
# runs-on: ubuntu-latest
# steps:
# - name: Checkout sources
# uses: actions/checkout@v2
#
# - name: Setup latest deno version
# uses: denoland/setup-deno@main
# with:
# deno-version: v1.x
#
# - name: Run deno test --doc
# run: deno test --allow-all --unstable --doc --import-map import_map.json
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,29 @@
[![checks](https://github.com/denosaurs/mess/actions/workflows/checks.yml/badge.svg)](https://github.com/denosaurs/mess/actions/workflows/checks.yml)
[![License](https://img.shields.io/github/license/denosaurs/mess)](https://github.com/denosaurs/mess/blob/master/LICENSE)

Modern messaging with multi-backend support and ergonomic interfaces.
Mess is a modern, broker-agnostic message queue for use in a distributed
environment. Currently, AMQP is supported, with plans to add support for other
platforms such as Redis and MQTT in the future.

## Example

...
This example demonstrates how to use the AMQP message queue with the json
serializer and deserializer:

```ts
import { AMQPMessageQueue } from "https://deno.land/x/mess/message_queue/amqp.ts";
import * as json from "https://deno.land/x/mess/serializer_deserializer/json.ts";

const queue = new AMQPMessageQueue("test", {
serializerDeserializer: json,
connection: Deno.env.get("AMQP"),
});

for await (const [event] of queue.on("message")) {
console.log(event.data);
event.deferred.resolve();
}
```

## Documentation

Expand All @@ -27,6 +45,6 @@ Check out the docs
Pull request, issues and feedback are very welcome. Code style is formatted with
`deno fmt` and commit messages are done following Conventional Commits spec.

### Licence
### License

Copyright 2023, the Denosaurs team. All rights reserved. MIT license.

0 comments on commit 505d3ce

Please sign in to comment.