Skip to content

Commit

Permalink
Fix some readme mistakes
Browse files Browse the repository at this point in the history
  • Loading branch information
nistei committed Nov 29, 2020
1 parent 799d9f1 commit 71a21fe
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Taf.get(icao, source)

### ATIS
```ts
import { Taf } from '@flybywiresim/api-client';
import { Atis } from '@flybywiresim/api-client';

Atis.get(icao, source)
.then(data => {
Expand Down Expand Up @@ -148,7 +148,7 @@ This releases the flight number for reuse and removes the flight from the live m

#### Sending a message
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.sendMessage(recipient, message)
.then(data => {
Expand All @@ -165,7 +165,7 @@ Messages will be filtered for profanity in the backend.

#### Receiving messages
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.fetchMessages()
.then(data => {
Expand All @@ -181,7 +181,7 @@ Messages can only be received once and will be acknowledged by this transaction.

#### Fetch all active connections
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.fetchConnections(skip, take)
.then(data => {
Expand All @@ -198,7 +198,7 @@ Telex.fetchConnections(skip, take)

#### Fetch a certain connection
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.fetchConnection(id)
.then(data => {
Expand All @@ -212,7 +212,7 @@ Telex.fetchConnection(id)

#### Find a connection by a flight number
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.findConnection(flight)
.then(data => {
Expand All @@ -228,7 +228,7 @@ This will only return an active flight since flight numbers can be reused.

#### Count active connections
```ts
import { Airport } from '@flybywiresim/api-client';
import { Telex } from '@flybywiresim/api-client';

Telex.countConnections()
.then(data => {
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@flybywiresim/api-client",
"version": "0.2.1",
"version": "0.2.2",
"description": "Client library for the FlyByWire Simulations API",
"main": "lib/index.js",
"scripts": {
Expand Down

0 comments on commit 71a21fe

Please sign in to comment.