@headwindsimulations/api-client 0.1.0 → 1.0.0

package/README.md

@@ -1,20 +1,22 @@
-# <img src="https://raw.githubusercontent.com/flybywiresim/fbw-branding/master/svg/FBW-Logo.svg" placeholder="FlyByWire" width="400"/>
-# FlyByWire Simulations API Client
+# <img src="https://headwindsim.net/assets/images/headwind-logo-light.png" placeholder="HeadwindSimulations" width="400"/>
+# Headwind Simulations API Client for FlyByWire API
 
-The official JavaScript client for the FBW API.
+This is a unofficial JavaScript client for the FlyByWire API and changed for Headwind Simulations needs.
 The library supports both JavaScript and TypeScript.
+If you want to use the FlyByWire API stick to the Official API-Client: https://github.com/flybywiresim/api-client
+
 
 ## Installation
 
 Install the client library using npm:
 
-    $ npm install --save @flybywiresim/api-client
+    $ npm install --save @headwindsimulations/api-client
 
 ## Usage
 
 ### Initializing the client
 ```ts
-import { NXApi } from '@flybywiresim/api-client';
+import { NXApi } from '@headwindsimulations/api-client';
 
 NXApi.url = new URL('http://localhost:3000');
 ```
@@ -23,7 +25,7 @@ By default, the URL is set to `https://api.flybywiresim.com`. If this is the des
 
 ### METAR
 ```ts
-import { Metar } from '@flybywiresim/api-client';
+import { Metar } from '@headwindsimulations/api-client';
 
 Metar.get(icao, source)
   .then(data => {
@@ -43,7 +45,7 @@ Metar.get(icao, source)
 
 ### TAF
 ```ts
-import { Taf } from '@flybywiresim/api-client';
+import { Taf } from '@headwindsimulations/api-client';
 
 Taf.get(icao, source)
   .then(data => {
@@ -61,7 +63,7 @@ Taf.get(icao, source)
 
 ### ATIS
 ```ts
-import { Atis } from '@flybywiresim/api-client';
+import { Atis } from '@headwindsimulations/api-client';
 
 Atis.get(icao, source)
   .then(data => {
@@ -81,7 +83,7 @@ Atis.get(icao, source)
 
 ### Airport
 ```ts
-import { Airport } from '@flybywiresim/api-client';
+import { Airport } from '@headwindsimulations/api-client';
 
 Airport.get(icao)
   .then(data => {
@@ -96,7 +98,7 @@ Airport.get(icao)
 
 ### ATC
 ```ts
-import { Atis } from '@flybywiresim/api-client';
+import { Atis } from '@headwindsimulations/api-client';
 
 ATC.get(source)
   .then(data => {
@@ -116,7 +118,7 @@ ATC.get(source)
 
 #### Connect to TELEX system
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.connect(status)
   .then(data => {
@@ -132,7 +134,7 @@ The backend might block certain flight numbers from being used for various reaso
 
 #### Update the TELEX status
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.update(status)
   .then(data => {
@@ -150,7 +152,7 @@ The status can only be updated once a connection has been established.
 
 #### Disconnect from TELEX system
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.disconnect()
   .then(data => {
@@ -167,7 +169,7 @@ This releases the flight number for reuse and removes the flight from the live m
 
 #### Sending a message
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.sendMessage(recipient, message)
   .then(data => {
@@ -184,7 +186,7 @@ Messages will be filtered for profanity in the backend.
 
 #### Receiving messages
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.fetchMessages()
   .then(data => {
@@ -200,7 +202,7 @@ Messages can only be received once and will be acknowledged by this transaction.
 
 #### Fetch a single page of active connections
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.fetchConnections(skip, take, bounds)
   .then(data => {
@@ -218,7 +220,7 @@ Telex.fetchConnections(skip, take, bounds)
 
 #### Fetch all active connections
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.fetchAllConnections(bounds, callback)
   .then(data => {
@@ -233,7 +235,7 @@ Telex.fetchAllConnections(bounds, callback)
 
 #### Fetch a certain connection
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.fetchConnection(id)
   .then(data => {
@@ -247,7 +249,7 @@ Telex.fetchConnection(id)
 
 #### Find all active connections matching a flight number
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.findConnection(flight)
   .then(data => {
@@ -261,7 +263,7 @@ Telex.findConnection(flight)
 
 #### Count active connections
 ```ts
-import { Telex } from '@flybywiresim/api-client';
+import { Telex } from '@headwindsimulations/api-client';
 
 Telex.countConnections()
   .then(data => {
@@ -275,7 +277,7 @@ Telex.countConnections()
 
 #### Get the newest commit for a branch
 ```ts
-import { GitVersions } from '@flybywiresim/api-client';
+import { GitVersions } from '@headwindsimulations/api-client';
 
 GitVersions.getNewestCommit(user, repo, branch)
   .then(data => {
@@ -291,7 +293,7 @@ GitVersions.getNewestCommit(user, repo, branch)
 
 #### Get all releases for a repository
 ```ts
-import { GitVersions } from '@flybywiresim/api-client';
+import { GitVersions } from '@headwindsimulations/api-client';
 
 GitVersions.getReleases(user, repo)
   .then(data => {
@@ -306,7 +308,7 @@ GitVersions.getReleases(user, repo)
 
 #### Get open pull requests for a repository
 ```ts
-import { GitVersions } from '@flybywiresim/api-client';
+import { GitVersions } from '@headwindsimulations/api-client';
 
 GitVersions.getPulls(user, repo)
   .then(data => {
@@ -321,7 +323,7 @@ GitVersions.getPulls(user, repo)
 
 #### Get the artifact URL for a pull request
 ```ts
-import { GitVersions } from '@flybywiresim/api-client';
+import { GitVersions } from '@headwindsimulations/api-client';
 
 GitVersions.getArtifact(user, repo, pull)
   .then(data => {
@@ -340,7 +342,7 @@ GitVersions.getArtifact(user, repo, pull)
 
 #### Get the charts for an airport
 ```ts
-import { Charts } from '@flybywiresim/api-client';
+import { Charts } from '@headwindsimulations/api-client';
 
 Charts.get(icao, source)
   .then(data => {
@@ -357,7 +359,7 @@ Charts.get(icao, source)
 
 #### Fetch data for all GNSS satellites
 ```ts
-import { Atis } from '@flybywiresim/api-client';
+import { Atis } from '@headwindsimulations/api-client';
 
 GNSS.get()
   .then(data => {
@@ -371,7 +373,7 @@ GNSS.get()
 
 #### Send the request
 ```ts
-import { Hoppie } from '@flybywiresim/api-client';
+import { Hoppie } from '@headwindsimulations/api-client';
 
 const body {
   logon: 'XXXXXXXXX',
@@ -390,4 +392,7 @@ Hoppie.post(body)
 
 ## License
 
-This software is licensed under the [MIT license](https://github.com/flybywiresim/api-client/blob/main/LICENSE).
+This software is licensed under the [MIT license](https://github.com/headwindsimulations/api-client/blob/main/LICENSE).
+
+## Credits
+Based on the Open-Source [FlyByWire Simulations API-Client](https://github.com/flybywiresim/api-client).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@headwindsimulations/api-client",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "description": "Client library for the FlyByWire Simulations API",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",