@buerli.io/headless 0.13.1-beta.9 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,26 +1,24 @@
1
- # @buerli.io/headless
2
-
3
- Usage information and reference details can be found in the [buerli documentation](https://buerli.io/api)
4
-
5
- `@buerli.io/headless` is completely implemented in Typescript and accordingly offers documented types for all interfaces.
6
-
7
- ## Install
8
-
9
- ```sh
10
- npm install @buerli.io/headless
11
- yarn add @buerli.io/headless
12
- ```
13
-
14
- ### Usage
15
-
16
- ```jsx
17
- import { history } from '@buerli.io/headless'
18
- import { init, SocketIOClient } from '@buerli.io/classcad'
19
-
20
- init(id => return new SocketIOClient('ws://localhost:9091', id))
21
- const history = new history()
22
- instance.init(api => {
23
- const part = await api.createPart('Part')
24
- // ...
25
- })
26
- ```
1
+ > ⚠️ **DEPRECATED**
2
+ >
3
+ > This package is deprecated and is no longer actively maintained.
4
+ > Please have a look at the [buerli documentation](https://buerli.io/docs) to get started with the replacement.
5
+
6
+ # @buerli.io/headless
7
+
8
+ Usage information and reference details can be found in the [buerli documentation](https://buerli.io/docs)
9
+
10
+ `@buerli.io/headless` is completely implemented in Typescript and accordingly offers documented types for all interfaces.
11
+
12
+ ## Install
13
+
14
+ ```sh
15
+ npm install @buerli.io/headless
16
+ yarn add @buerli.io/headless
17
+ ```
18
+
19
+ ### Links to our homepages and documentations
20
+
21
+ - [buerli.io](https://buerli.io)
22
+ - [buerligons.io](https://buerligons.io)
23
+ - [classcad.ch](https://classcad.ch)
24
+ - [awv-informatik.ch](https://awv-informatik.ch)