Skip to content

Commit

Permalink
TELESTION-449 Add a README to the backend-deno library
Browse files Browse the repository at this point in the history
  • Loading branch information
pklaschka committed Dec 21, 2023
1 parent 7424500 commit 71c662d
Show file tree
Hide file tree
Showing 2 changed files with 51 additions and 0 deletions.
21 changes: 21 additions & 0 deletions backend-deno/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2023 WüSpace e. V.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
30 changes: 30 additions & 0 deletions backend-deno/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Telestion Service Framework for Deno

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10407142.svg)](https://doi.org/10.5281/zenodo.10407142)
![GitHub License](https://img.shields.io/github/license/wuespace/telestion)

This library provides a framework for building Telestion services in Deno.

## Usage

```typescript
import {startService} from 'https://deno.land/x/telestion/mod.ts';

const {nc} = await startService();
```

`nc` is a `NatsConnection` instance. The library automatically handles the connection to the NATS broker.

For more information, have a look at
the [documentation](https://docs.telestion.wuespace.de/Backend%20Development/typescript/).

## Behavior Specification

The behavior of this library is specified in
the [Behavior Specification](https://docs.telestion.wuespace.de/Backend%20Development/service-behavior/).
This specification is also used to test the library.
The source code of the tests can be found in the repository under `/backend-features`.

## License

This project is licensed under the terms of the [MIT license](LICENSE).

0 comments on commit 71c662d

Please sign in to comment.