Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hummelstrand authored Nov 22, 2023
1 parent d08722a commit 4b74e54
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,20 @@
# Sofie: The Modern TV News Studio Automation System (Ember+ Connection)
# Sofie Ember+ Connection

A TyepScript implementation of [Lawo's Ember+](https://github.com/Lawo/ember-plus) control protocol for Node.
This is the _Ember+ Connection_ library of the [**Sofie** TV Automation System](https://github.com/nrkno/Sofie-TV-automation/), a TypeScript implementation of [Lawo's Ember+](https://github.com/Lawo/ember-plus) control protocol for Node.js. It has been tested with _Lawo Ruby_, _Lawo R3lay_, and _Lawo MxGUI_.

It has been tested with Lawo Ruby, Lawo R3lay and Lawo MxGUI.
The current version is very losely based on the original library and Mr. Gilles Dufour's rewrites. It is however rewritten almost completely from scratch and bears little to no resemblance to earlier libraries.

The current version is very losely based on the original library and Mr Gilles Dufour's rewrites. It is however rewritten
almost completely from scratch and bears little to no resemblance to earlier libraries.

## Example usage
### Repository-specific Info for Developers
* [Developer Info](DEVELOPER.md)
* [Contribution Guidelines](CONTRIBUTING.md)

### General Sofie System Info
* [Documentation](https://nrkno.github.io/sofie-core/)
* [Releases](https://nrkno.github.io/sofie-core/releases)


## Example Usage

### Client

Expand Down Expand Up @@ -74,7 +81,7 @@ client
)
```

### Setting new value
### Setting New Value

```javascript
client = new EmberClient(LOCALHOST, PORT)
Expand All @@ -101,7 +108,7 @@ const req = await client.invoke(fn, 1, 2, 3)
console.log('result', await req.response)
```

### Basic server
### Basic Server

```javascript
const {
Expand Down Expand Up @@ -206,3 +213,6 @@ const tree = {

s.init(tree) // initiate the provider with the tree
```
---

_The NRK logo is a registered trademark of Norsk rikskringkasting AS. The license does not grant any right to use, in any way, any trademarks, service marks or logos of Norsk rikskringkasting AS._

0 comments on commit 4b74e54

Please sign in to comment.