@openfin/cloud-api 0.0.1-alpha.12a0cef → 0.0.1-alpha.8d5ffd0
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 +59 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
# @openfin/cloud-api
|
|
2
|
+
|
|
3
|
+
Client library for interacting with notifications when used as part of the OpenFin Cloud Platform.
|
|
4
|
+
|
|
5
|
+
<!-- High-level description of what this package is useful for. Include specific use case/s whenever possible. -->
|
|
6
|
+
|
|
7
|
+
<!-- Depending on package, explain why this package vs a different one, and link to other options. -->
|
|
8
|
+
|
|
9
|
+
Related packages:
|
|
10
|
+
|
|
11
|
+
- [@openfin/workspace](https://www.npmjs.com/package/@openfin/workspace)
|
|
12
|
+
- [@openfin/workspace-platform](https://www.npmjs.com/package/@openfin/workspace-platform)
|
|
13
|
+
|
|
14
|
+
<!-- For more information about how to work with this package, see [{the relevant docs}]({relevant_docs_link}). -->
|
|
15
|
+
|
|
16
|
+
## Prerequisites
|
|
17
|
+
|
|
18
|
+
None.
|
|
19
|
+
|
|
20
|
+
## Installation
|
|
21
|
+
|
|
22
|
+
With npm:
|
|
23
|
+
|
|
24
|
+
> npm -i @openfin/cloud-api
|
|
25
|
+
|
|
26
|
+
With pnpm:
|
|
27
|
+
|
|
28
|
+
> pnpm add @openfin/cloud-api
|
|
29
|
+
|
|
30
|
+
With bun:
|
|
31
|
+
|
|
32
|
+
> bun add @openfin/cloud-api
|
|
33
|
+
|
|
34
|
+
With yarn:
|
|
35
|
+
|
|
36
|
+
> yarn global add @openfin/cloud-api
|
|
37
|
+
|
|
38
|
+
## Usage
|
|
39
|
+
|
|
40
|
+
<!-- If this is a command-line tool, this is some basic usage info. -->
|
|
41
|
+
|
|
42
|
+
<!-- If it is a library, link to the specific section of the developer guide or api refdoc. (This might mean repeating links already -->
|
|
43
|
+
<!-- provided in the first section of the readme. This is FINE.) -->
|
|
44
|
+
|
|
45
|
+
<!-- ## For more information -->
|
|
46
|
+
|
|
47
|
+
<!-- - [{Developer guide}]({relevant_docs_link}). -->
|
|
48
|
+
<!-- - [{API reference}]({relevant_docs_link}). -->
|
|
49
|
+
<!-- - See the [workspace-starter]() project for example code.-->
|
|
50
|
+
|
|
51
|
+
## License
|
|
52
|
+
|
|
53
|
+
Copyright 2024-2024 OpenFin
|
|
54
|
+
|
|
55
|
+
The code in this package is distributed under the {relevant license}.
|
|
56
|
+
|
|
57
|
+
However, if you run this code, it may call on the OpenFin RVM or OpenFin Runtime, which are covered by OpenFin's Developer, Community, and Enterprise licenses. You can learn more about OpenFin licensing at the link listed below or email us at support@openfin.co with questions.
|
|
58
|
+
|
|
59
|
+
- [Developer license](https://openfin.co/developer-agreement/)
|